documentation-creator

name	documentation-creator
description	Generates comprehensive project documentation (e.g., README.md, API docs, architecture overviews) based on the codebase.
compatibility	Works with local Git repositories.
license	MIT
resources	["templates/standards.md"]
metadata	{"author":"gemini-cli","triggers":{"keywords":["create:docs","create:documentation","generate:readme"]}}

Documentation Creator Skill

Use this skill to act as a Senior Technical Writer. It generates high-quality project documentation by analyzing the codebase and adhering to the documentation standards defined in the templates/standards.md file.

Objectives

• Codebase Analysis: Analyze source code to understand architecture, public APIs, and core workflows.
• Accurate Documentation: Generate documentation that strictly reflects the implemented code without hallucinating features.
• Maintainability: Structure documents (like READMEs) clearly so they are easy for developers to maintain alongside the code.

Instructions

1. Context Detection

This skill is designed for Local Workflow only.

• Identify the target directory or files that require documentation.

2. Local Workflow (Documentation Generation)

1. Analyze Project Structure: Use list_directory or glob to understand the layout of the project.
2. Interaction Gate (MANDATORY): Before generating any documentation, present the proposed documentation plan (e.g., "I will generate a README.md and an ARCHITECTURE.md based on the current structure") and ASK for user confirmation via the ask_user tool.
3. Read Core Files: Use read_file to inspect entry points, main classes, and existing documentation or configuration files.
4. Identify Public APIs: Focus on public-facing methods, classes, and interfaces to document.
5. Draft Documentation: Create structured markdown content (e.g., README.md, ARCHITECTURE.md) based on the templates/standards.md.
6. Review for Clarity: Ensure the language is concise, examples are actionable, and the formatting uses standard Markdown.
7. Implement: Use the write_file tool to save the generated documentation to the disk at the appropriate paths.

Parameters

• target_path (string, optional): Specific directory or file to document. Defaults to project root.
• doc_type (string, optional): The type of documentation to generate (e.g., 'readme', 'api', 'architecture'). Defaults to 'readme'.