Skip to content

Latest commit

 

History

History
213 lines (169 loc) · 4.86 KB

dir-setup.md

File metadata and controls

213 lines (169 loc) · 4.86 KB

Project Documentation Structure & Organization

Recommended Directory Structure 📁

project_root/
├── project_specification/
│   ├── project_overview.md
│   ├── architecture.md
│   └── milestones/
│       ├── milestone_1/
│       │   ├── milestone_spec.md
│       │   └── features/
│       │       ├── feature_1/
│       │       │   ├── contract.md
│       │       │   ├── validation.md
│       │       │   └── integration.md
│       │       └── feature_2/
│       │           └── ...
│       └── milestone_2/
│           └── ...
├── implementations/
│   ├── milestone_1/
│   │   ├── project_1/
│   │   │   ├── specs/
│   │   │   │   ├── project_spec.md
│   │   │   │   └── features/
│   │   │   │       ├── auth_contract.md
│   │   │   │       └── user_contract.md
│   │   │   └── src/
│   │   └── project_2/
│   │       └── ...
│   └── milestone_2/
│       └── ...
└── docs/
    ├── templates/
    │   ├── feature_contract_template.md
    │   ├── project_spec_template.md
    │   └── validation_template.md
    └── guidelines/
        └── naming_conventions.md

File Naming Conventions 📝

1. Milestone Level

milestone_[number]_[short_name].md
Example: milestone_1_authentication.md

2. Project Level

[project_name]_spec.md
Example: user_service_spec.md

3. Feature Contracts

[feature_name]_contract.md
Example: jwt_auth_contract.md

4. Validation Documents

[feature_name]_validation.md
Example: jwt_auth_validation.md

LLM Reference Strategy 🔗

1. Context Loading

Please load these specification files for context:

1. Project Overview:
[Copy content from project_specification/project_overview.md]

2. Current Milestone:
[Copy content from project_specification/milestones/milestone_1/milestone_spec.md]

3. Feature Contract:
[Copy content from implementations/milestone_1/project_1/specs/features/auth_contract.md]

2. Reference Management

Single Feature Implementation

Working on: Authentication Feature
Contract Reference: implementations/milestone_1/project_1/specs/features/auth_contract.md

Please implement according to this contract:
[Paste relevant contract sections]

Multi-Feature Integration

Integrating: Auth + User Features

Contracts:
1. Auth: [Paste key points]
2. User: [Paste key points]

Integration Requirements:
[Paste integration requirements]

Document Templates 📄

1. Feature Contract Template

# Feature: [Name]
Version: [x.y.z]
Last Updated: [YYYY-MM-DD]

## Interface Contract
### Input
- Type definitions
- Validation rules

### Output
- Return types
- Error states

## Dependencies
- List dependencies

## Validation Criteria
- Success conditions
- Test cases

2. Project Spec Template

# Project: [Name]
Milestone: [Number]
Status: [Planning/In Progress/Complete]

## Overview
- Purpose
- Scope

## Features
- List features
- Link to contracts

## Integration Points
- System interfaces
- Dependencies

LLM Interaction Examples 💬

1. Initial Load

Please load the following project context:

1. Project Overview:
[project_specification/project_overview.md contents]

2. Current Milestone:
[project_specification/milestones/milestone_1/milestone_spec.md contents]

Please confirm you've processed these documents and are ready for feature-level work.

2. Feature Implementation

Working on Feature: JWT Authentication
Reference Files:
1. Feature Contract: implementations/milestone_1/project_1/specs/features/jwt_auth_contract.md
[paste contract]

2. Integration Requirements: implementations/milestone_1/project_1/specs/features/integration.md
[paste relevant sections]

Please implement the JWT validation middleware according to these specifications.

3. Validation Check

Validate implementation against:
1. Feature Contract: [paste relevant sections]
2. Test Cases: [paste test requirements]
3. Integration Points: [paste integration requirements]

Current Implementation:
[paste code]

Best Practices 🎯

  1. Document References

    • Use relative paths in documentation
    • Keep contracts atomic and focused
    • Version control documentation

  2. Context Management

    • Load only relevant sections
    • Reference parent documents when needed
    • Keep feature contracts self-contained

  3. Organization Tips

    • Group related features
    • Maintain clear hierarchy
    • Use consistent naming

  4. Version Control

    • Track documentation changes
    • Link commits to specs
    • Update validation status