メニュー
Create comprehensive, beginner-friendly documentation for codebases. Use when writing READMEs, architecture guides, code comments, or API documentation.
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
直接コマンドでは確認用 Prompt が省略されます。実行前にソースを確認してください。
npx skills add https://github.com/alunadev/ald-skills --skill codebase-documenterコマンドは1行のまま表示されます。コピー前に横へスクロールして全体を確認してください。
ローカルで確認しますか？SkillsMP が現在取得できるファイルをダウンロードできます。
Use PROACTIVELY to document new features, significant code changes, or when creating technical specifications for a feature not included in the original project technical specification. Specializes in creating comprehensive feature documentation for non-professional developers.
Write, read, and apply DESIGN.md files — Google Stitch's open AI-readable design-system format (YAML design tokens + Markdown rationale). Use when asked to "create a design.md", "extract a design system from [brand/PDF/site/screenshots]", "document this brand for AI tools", or when reverse-engineering a brand's visual identity into reusable tokens for an AI coding agent to apply consistently.
Builds complete bilingual email drafts from intent and audience. Use when the user asks to write, rewrite, localize, polish, or generate an email, campaign email, outreach message, customer update, follow-up, announcement, invite, sales email, internal note, or lifecycle email and wants clear subject lines, preheaders, body copy, CTAs, variants, or English and Spanish versions.
SKILL.md を表示中
SOC 職業分類に基づく
| name | codebase-documenter |
| description | Create comprehensive, beginner-friendly documentation for codebases. Use when writing READMEs, architecture guides, code comments, or API documentation. |
This skill enables creating comprehensive, beginner-friendly documentation for codebases. It provides structured templates and best practices for writing READMEs, architecture guides, code comments, and API documentation that help new users quickly understand and contribute to projects.
Use the templates in assets/templates/ and customize for the specific project.
Read as a beginner and verify that examples and instructions actually work.
Should include: What This Does, Quick Start, Project Structure, Key Concepts, Common Tasks, and Troubleshooting.
Should include: System Design, Directory Structure, Data Flow, Key Design Decisions, Module Dependencies, and Extension Points.
Focus on explaining why instead of what. Include examples for complex functions and document edge cases.
Should include: Endpoint Name, Purpose, Auth, Request/Response formats, Example Usage (curl/code), and Common Errors.
assets/templates/README.template.mdassets/templates/ARCHITECTURE.template.mdassets/templates/API.template.mdassets/templates/CODE_COMMENTS.template.mdreferences/documentation_guidelines.mdreferences/visual_aids_guide.md