Documentation Skill

Documentation Skill

Ensures all documentation follows project standards and prevents redundant files.

Purpose

This skill provides tools and workflows for efficient documentation management:

• Section-level interaction scripts (search, get, update without reading full files)
• Document templates for consistent structure
• Workflows for common documentation tasks
• Rules and standards to prevent redundancy

When to Use This Skill

Use this skill when:

• Creating new documentation for features, screens, or architecture
• Updating existing documentation after code changes
• Finding and consolidating duplicate documentation
• Splitting large documentation files (>500 lines)
• Searching for specific information in docs
• Checking documentation quality and compliance

Core Principles

1. DRY (Don't Repeat Yourself)

• Check for existing documentation before creating new files
• Update existing docs instead of creating duplicates
• Consolidate related information into single files

2. Screen-Based Organization

docs/
├── README.md              # Master index (DO NOT MODIFY)
├── guides/                # User and developer guides
├── architecture/          # Architecture docs
└── screens/               # Screen-specific docs
    └── {screen-name}/
        ├── README.md      # Overview (required)
        ├── features.md    # Features (optional)
        ├── technical.md   # Technical (required)