writing-architecture
Skill0 starsChanged 8 months agoApache-2.0View on GitHub
Architecture document standards — document format, component boundaries, data model documents. Use when creating or editing doc/architecture/ files.
In this repository12 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- specification/CLAUDE.mdCLAUDE.md
- src/CLAUDE.mdCLAUDE.md
- tasks/CLAUDE.mdCLAUDE.md
- test/CLAUDE.mdCLAUDE.md
- cleanupSkill
- diagnoseSkill
- sddSkill
- triageSkill
- writing-specsSkill
- writing-tasksSkill
- writing-testsSkill
The file
We split this skill into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 17
Keep content language-agnostic.
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Architecture Document Standards
Architecture Documents
Layer: 3 -- Design Specification
Location: doc/architecture/<component-or-concern>.md
Derived from: doc/features/
Authoritative for: specification/
- Open each document with a pointer to the corresponding feature document.
- Describe how -- pipelines, data flows, component responsibilities, boundary contracts. Do not re-state what (that belongs in the feature document).
- Keep content language-agnostic. Platform-specific statements go in Language-Specific Notes.
- Declare component boundaries and inter-component contracts explicitly.
- Cross-check all entity names, node labels, and field names against
data-models/before finalizing.
One per: component, pipeline, or cross-cutting concern
Component Boundary Document
Location: doc/architecture/component-boundaries.md (singleton)
Summary derived from architecture documents -- not a source of truth. Architecture documents win on disagreement. Maintains: component taxonomy, dependency graph, boundary contracts, source-to-specification mapping.
Data Model Documents
Location: doc/architecture/data-models/<domain-or-component>.md
Extract when entities are shared across components or complex enough to warrant standalone treatment. Define entities with domain-level types, constraints, validation rules, and relationships with cardinality.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

