Repository navigation
Usage of particular documents for external feedback loops? #2146
|
I plan to introduce Spec-Driven Development into our processes. As we extend an existing product with new or modified features in response to customer "change requests", I prefer Open-Spec because of its focus on brownfield projects. I would like to ask for your advice on a specific issue I have in my mind: We have established processes of writing a very detailed internal specification as the basis for development. For this I plan to use Open-Spec. Does anyone have any ideas on how best to handle this in the scope of Open-Spec? My preference would be to generate the initial client-facing solution description from the open-spec information, then reconcile any feedback received from the client with the open-spec information and modify only the changed sections in the open-spec files as well as in the client solution description; without completely regenerating the external description (as that could lead to a substantially different text/wording). Thank you very much for your help and advice in advance! |
Replies: 1 comment 1 reply
|
You can make the client document a first-class artifact with a custom schema, so it lives next to the specs and gets updated section by section instead of regenerated.
bash
yaml
and create templates/client-brief.md with your fixed headings (Background / Problem / Solution).
Export client-brief.md to Word/PDF with Pandoc (pandoc client-brief.md -o brief.docx --reference-doc=your-template.docx) and send it. Keeping both documents in one change means they’re reviewed and archived together, and the client never sees the internal specs. If this helps, please mark it as the answer. |
You can make the client document a first-class artifact with a custom schema, so it lives next to the specs and gets updated section by section instead of regenerated.
bash
openspec schema fork spec-driven client-facing
yaml
generates: client-brief.md
description: Customer-facing solution description (no technical detail)
template: client-brief.md
instruction: |
Write for the customer: Background, Problem, High-level solution.
No code, file names or internal specs.
When updating, change only the sections affected by the change;
keep all other wordi…