timetracker/DOCS.md

Documentation Guide

Documentation Files

File	Purpose	When to Update
AGENTS.md	Code conventions, commands, architecture, AI agent workflow	Adding patterns, changing conventions, modifying structure, updating agent workflow
README.md	Setup instructions, API reference, features list	New endpoints, config changes, new features, technology stack changes
project.md	Requirements, data model, functional specifications	Business logic changes, new entities, validation rules, UI requirements
DOCS.md	Documentation standards and index	Documentation process changes, new documentation files

Documentation Standards

• Use Markdown formatting
• Keep entries concise and actionable
• Use code blocks for commands and examples
• Match existing tone and style
• Maintain logical ordering in lists

Maintenance Rules

AI Agents Must Update Documentation When:

1. Adding new code patterns or conventions
2. Modifying API endpoints or configuration
3. Changing business logic or data models
4. Adding new features or entities

Review Checklist

• Documentation reflects code changes
• Examples are accurate and tested
• Formatting is consistent
• No outdated information remains