review-documentation

Files (1)

• SKILL.md

SKILL.md (first lines)

# Documentation Strategy

## Overview

Projects use structured documentation following specialized templates and patterns. This rule defines the general documentation strategy that encompasses multiple specialized approaches.

## Documentation Structure

### `README.md` - Developer Onboarding

- **Purpose**: Minimal document for developers to get started quickly
- **Pattern**: Concise, action-oriented, no documentation duplication
- **Content**: Quick start, prerequisites, basic usage, development commands
- **References**: May include links to detailed documentation in `memory-bank/` and `docs/` when appropriate
- **Lifecycle**: Updated when setup/usage changes, kept minimal
- **Reading**: First file to read for new developers

### `memory-bank/` - Working Memory

Applies only if folder `memory-bank/` exists in the project.

- **Purpose**: Milestone-focused working memory for developers and coding agents
- **Pattern**: Follows cline memory bank pattern (see "memory-bank-by-cline" skill)
- **Content**: Current iteration context, active decisions, progress tracking
- **Lifecycle**: Updated frequently during development, reviewed at milestone completion
- **Reading**: MUST read ALL files in sequence defined in the "memory-bank-by-cline" skill

### `docs/architecture` - Architecture Documentation

- **Purpose**: Long-term architecture and interface documentation
- **Pattern**: Follows arc42 architecture documentation template
- **Content**: Stable reference materials, interface specifications, architecture decisions
- **Lifecycle**: Created when stable, updated when architecture changes
- **Reading**: Read as needed for specific context

## Usage Guidelines

- **README.md**: Always present, minimal developer onboarding
- **memory-bank/**: Current milestone context, active development insights, progress tracking
- **docs/**: Stable interface specifications, architecture decisions, long-term references

### Migration Strategy

- Content moves from `memory-bank/` to `docs/` when it becomes stable
- Review at milestone completion to identify content for migration
- Maintain clear separation between working memory and reference documentation

## References

- [arc42 Architecture Documentation](https://docs.arc42.org/)
- [Cline Memory Bank Pattern](.claude/skills/memory-bank-by-cline/SKILL.md)

From wonderbird/ai-agent-workspace, GPL-3.0.

More from wonderbird/ai-agent-workspace