35 lines
1.4 KiB
Markdown
35 lines
1.4 KiB
Markdown
 
|
# Project Documentation Specification
|
||
|
|
|
||
|
|
## ADDED Requirements
|
||
|
|
|
||
|
|
### Requirement: README File
|
||
|
|
The project root SHALL contain a README.md file that serves as the primary entry point for developers and AI assistants.
|
||
|
|
|
||
|
|
#### Scenario: Repository discovery
|
||
|
|
- **WHEN** a developer or AI assistant discovers the repository
|
||
|
|
- **THEN** they can read README.md to understand project purpose and current state
|
||
|
|
|
||
|
|
### Requirement: Current State Documentation
|
||
|
|
The README.md SHALL accurately describe only the current implementation state, not planned features.
|
||
|
|
|
||
|
|
#### Scenario: Accurate project status
|
||
|
|
- **WHEN** reading the README.md
|
||
|
|
- **THEN** it reflects what is actually implemented
|
||
|
|
- **AND** does not promise or describe unimplemented features
|
||
|
|
|
||
|
|
### Requirement: Getting Started Guide
|
||
|
|
The README.md SHALL include instructions for contributors to get started with development.
|
||
|
|
|
||
|
|
#### Scenario: New contributor onboarding
|
||
|
|
- **WHEN** a new contributor wants to start developing
|
||
|
|
- **THEN** README.md provides clear setup steps
|
||
|
|
- **AND** explains the OpenSpec-based workflow
|
||
|
|
|
||
|
|
### Requirement: OpenSpec Reference
|
||
|
|
The README.md SHALL reference the OpenSpec documentation structure for detailed specifications.
|
||
|
|
|
||
|
|
#### Scenario: Finding detailed specs
|
||
|
|
- **WHEN** a developer needs detailed technical specifications
|
||
|
|
- **THEN** README.md directs them to the `openspec/` directory
|
||
|
|
- **AND** explains how to read and create proposals
|