← Corpus / lost-in-public / reminder
Reminder of Specification Template and Guidelines for AI Code Assistants
Guidlines and templates only work if you use them.
- Path
- reminders/Remind-a-Model-of-Specification-Guidelines.md
- Authors
- Michael Staton
- Augmented with
- Windsurf Cascade on Claude 3.5 Sonnet
- Tags
- Documentation · Specifications · Best-Practices · Contribution-Guide
Specification Development Guidelines
Purpose
This is a reminder to frequently refer to the specification template and guidelines. They are designed to:
- Standardize Documentation: Create a consistent structure across all technical specifications
- Enable AI Assistance: Make specifications easily parsable by AI systems for better code generation and analysis
- Facilitate Maintenance: Make it easier to update and extend specifications over time
- Improve Onboarding: Help new contributors understand the project’s technical landscape
When to Reference?
Attempting to plan a new specification, or to revise an existing specification.
Specification Template
content/lost-in-public/reminders/Specification-Guidelines-Template.md
Focal Points and Key Tasks:
- Each section and header is important to include, no lazy skipping.
- Each specification should make use of backlinks to other documentation and specifications. Use paths and backlinks where relevant.
- Specifications should have liberal use of mermaid diagrams and code snippets.