菜单
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命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 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
| 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基于 SOC 职业分类