Opinionated, comprehensive Markdown template enabling GitHub Copilot (or any AI assistant) to act as a structured System / Solution Designer. Provides conventions for requirements, architecture, detailed design, testing, operations, risk, and security documentation with traceability discipline.
Teams often lack a consistent, testable format for system design artifacts. This repo supplies:
- A single authoritative template (in
docs/system-designer-template.md) - Naming + ID schemes (REQ, NFR, COMP, FUNC, ADR, etc.)
- Traceability matrix rules
- Mermaid diagram patterns (context, sequence, deployment)
- Quality & validation checklist
Use it to bootstrap SRDs, architecture docs, design reviews, audits, or to guide AI-generated technical documents.
- Copy
docs/system-designer-template.mdinto your projectdocs/folder. - Replace all
{{PLACEHOLDERS}}in the Project Metadata & metadata headers. - Remove sections not relevant to your scope.
- Start with the SRD skeleton (Section 22) and populate highest-risk / highest-ambiguity areas first.
- Introduce Architecture → Detail Design → Test Plan incrementally; keep IDs monotonic.
- Run the Quality Checklist (Section 10) before sign-off / review.
| Path | Purpose |
|---|---|
docs/system-designer-template.md |
Master template (copy & customize) |
CHANGELOG.md |
Versioned changes to this template repo |
CONTRIBUTING.md |
How to propose improvements |
CODE_OF_CONDUCT.md |
Expected behavior & enforcement |
SECURITY.md |
Vulnerability disclosure guidelines |
LICENSE |
Open source license (MIT by default) |
Semantic versioning for template evolution. Update CHANGELOG.md for every modification using: Added / Changed / Deprecated / Removed / Fixed / Security sections.
See CONTRIBUTING.md. Small improvements welcome (clarity, additional diagram examples, missing quality gates). For bigger structural changes, open an issue first.
Report vulnerabilities via the process in SECURITY.md. Avoid filing sensitive details in public issues.
MIT — see LICENSE.
Generated & maintained with assistance from GitHub Copilot.
If this helps you, consider starring the repository so others can discover it.