Standardize documentation system: RFC, ADR, Spec, Design Doc, Roadmap#220
Merged
Conversation
Establish a formal documentation system with five document types, lifecycle management, archiving rules, and templates. Both human developers and AI agents must follow the standard. - Add docs/DOCUMENTATION.md as the authoritative standard - Create docs/adr/ with ADR-001 through ADR-007 covering existing architecture decisions - Create docs/spec/ and docs/design/ directories with templates and migration plan - Create standard templates for RFC, ADR, Spec, Design Doc - Migrate existing 4 RFCs to docs/rfc/archive/ with unified frontmatter format - Add README indexes for rfc/, adr/, spec/, design/ directories - Update docs/README.md, AGENTS.md, CONTRIBUTING.md, and PR template
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/DOCUMENTATION.mddocs/rfc/archive/with unified frontmatter formatdocs/spec/anddocs/design/directories with templates and migration plan for existing pattern documentationAGENTS.mdwith documentation system summary and Agent workflow conventionsCONTRIBUTING.mdwith documentation workflow table and directory guideDocumentation type overview
docs/rfc/docs/adr/docs/spec/docs/design/docs/ROADMAP.mdPlan = GitHub Issue (no separate document type).
New files
docs/DOCUMENTATION.md— authoritative documentation standarddocs/adr/ADR-001throughADR-007— architecture decision recordsdocs/adr/README.md,docs/rfc/README.md,docs/spec/README.md,docs/design/README.md— indexesdocs/rfc/_template.md,docs/adr/_template.md,docs/spec/_template.md,docs/design/_template.md— templatesMigrated files
docs/rfc/StateTransitionTable.md->docs/rfc/archive/StateTransitionTable.md(unified frontmatter, Implemented)docs/rfc/CompositeParallelTraversal.md->docs/rfc/archive/CompositeParallelTraversal.md(unified frontmatter, Implemented)docs/rfc/CompositeTreeSchemaValidation.md->docs/rfc/archive/CompositeTreeSchemaValidation.md(unified frontmatter, Implemented)docs/rfc/HierarchicalStateMachine.md->docs/rfc/archive/HierarchicalStateMachine.md(unified frontmatter, Implemented)Updated files
docs/README.md— reflect new directory structureAGENTS.md— add documentation system summary section with Agent workflow conventionsCONTRIBUTING.md— add documentation workflow table and directory guide.github/pull_request_template.md— add documentation checklist sectionMigration plan for existing pattern docs
Existing
docs/<PatternName>.mdfiles (Strategy.md, Composite.md, etc.) will be gradually split intodocs/spec/+docs/design/. Migration can be done per-pattern, not required in one PR. Seedocs/spec/README.mdfor the migration plan table.Test plan
dotnet build DesignPatterns.slnx -c Release— 0 warnings, 0 errorsdotnet test DesignPatterns.slnx -c Release— 657 tests passed, 0 failed