Can I use this for existing projects?

Absolutely. It analyzes existing project structures (such as package.json, Cargo.toml, or requirements.txt) to gather context before writing.

Does it replace my current README?

The skill prefers updating and improving your existing README over creating new files, ensuring your project history and existing content are preserved.

How does it ensure the documentation is accurate?

The skill spawns a specialized @writer agent that reads your actual source code to verify that all commands and examples are copy-paste ready and correct.

Does it support visual diagrams?

Yes, it can create architecture diagrams in either ASCII for maximum portability or Mermaid format for visual rendering on platforms like GitHub.

What types of documentation can this skill create?

It can generate comprehensive README files, detailed API documentation, and system architecture diagrams based on your specific project needs.

Docs Writer

Name: Docs Writer
Author: jjeremycai

byjjeremycai

콘텐츠 관리

Generates comprehensive project documentation, READMEs, and architecture diagrams by analyzing your source code.

소개

Docs Writer is a specialized skill designed to automate the creation of high-quality project documentation by deploying a dedicated @writer agent to scan and interpret your codebase. It handles everything from crafting a single comprehensive README to generating complex system architecture diagrams and detailed API references. By verifying all code examples and shell commands against the actual source files, this skill ensures that your documentation remains accurate, professional, and ready for immediate use in production environments.

주요 기능

0 GitHub stars
Multi-level scope selection from single READMEs to full API docs
Generates architecture diagrams in ASCII or Mermaid formats
Verifies all commands and code examples against actual project files
Automated codebase analysis for high-accuracy documentation
Consolidates information into streamlined, easy-to-navigate files

사용 사례

Standardizing API documentation and installation guides for existing codebases
Documenting a new open-source project from scratch for GitHub
Generating visual architecture diagrams for complex system overviews

소개

주요 기능

0 GitHub stars
Multi-level scope selection from single READMEs to full API docs
Generates architecture diagrams in ASCII or Mermaid formats
Verifies all commands and code examples against actual project files
Automated codebase analysis for high-accuracy documentation
Consolidates information into streamlined, easy-to-navigate files

사용 사례

Standardizing API documentation and installation guides for existing codebases
Documenting a new open-source project from scratch for GitHub
Generating visual architecture diagrams for complex system overviews