Skip to content

KJ-AIML/docs-boy-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

docs-boy

Comprehensive project documentation generator and maintainer for AI agents.

Install

npx skills add KJ-AIML/docs-boy-skill

What it does

  • Initialize docs - Create full documentation structure for new projects
  • Audit docs - Check existing docs against required structure
  • Generate changelogs - Create version changelogs from git changes
  • Track milestones - Create milestone tracking with test results
  • Pre-commit updates - Generate UPDATE-SUMMARY and changelog before commits

Documentation Structure

Creates and maintains:

/docs/
├── 01-System-Design.md        # Architecture overview
├── 02-Design-Patterns.md      # Patterns used
├── 03-Database-Design.md      # Schema and data models
├── 04-Tech-Stack.md           # Technologies
├── 05-Project-Structure.md    # Directory organization
├── 06-API-Documentation.md    # API endpoints
├── 07-Setup-Installation.md   # Getting started
├── 08-Contribution-Guide.md   # How to contribute
├── 09-Design-System.md        # UI/UX guidelines
├── BRAND-GUIDELINES.md        # Brand identity
├── UPDATE-SUMMARY.md          # Latest changes
├── changelogs/                # Version history
└── milestone/                 # Development tracking

Commands

Command Action
docs init Initialize full docs structure
docs audit Check docs completeness
docs update Update docs from code changes
docs changelog Generate version changelog
docs milestone Create milestone tracking
docs pre-commit Generate UPDATE-SUMMARY before commit

Usage Examples

User: "Create docs for this project"
→ Investigates codebase → Creates full /docs structure

User: "Check if my docs are complete"
→ Audits against required structure → Reports missing files

User: "Generate changelog for v1.2.0"
→ Analyzes git diff → Creates version-1.2.0.md

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors