Documentation Standards
File Naming
- Use semantic versioning (v1, v2, v3)
- Prefix conventions:
- @00.x: Meta documents
- @01-05: Core documents
- @$: Reference documents
Markdown Guidelines
- Use headers hierarchically (H1 > H2 > H3)
- Include navigation headers
- Use relative links for cross-references
- Code blocks must specify language
Cross-References
- Always use relative paths
- Link format:
[Title](../relative/path.md)
- Reference format:
[Document Section]
Version Control
- Document changes in changelog
- Update Documentation Map
- Maintain SSOT principles
Directory Structure
- /docs: Documentation root
- /docs/system: Internal docs
- /docs/api: API documentation
- /docs/architecture: System design