14 skills found
This skill should be used when writing documentation for codebases, including README files, architecture documentation, code comments, and API documentation. Use this skill when users request help documenting their code, creating getting-started guides, explaining project structure, or making codebases more accessible to new developers. The skill provides templates, best practices, and structured approaches for creating clear, beginner-friendly documentation.
Use this skill when the user requests to generate, create, or improve documentation for code, APIs, libraries, repositories, or software projects. Supports README generation, API reference documentation, inline code comments, architecture documentation, changelog generation, and developer guides. Trigger on requests like "document this code", "create a README", "generate API docs", "write developer guide", or when analyzing codebases for documentation purposes.
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks.
Create a README.md file for the project
Use when the user wants to translate a repository README, make a repo multilingual, localize docs, add a language switcher, internationalize the README, or update localized README variants in a GitHub-style repository.
Use for PLANNING documentation with phased analysis (4 phases), gap identification, and structured knowledge modeling. Best for documentation audits, completeness analysis, and documentation strategy planning. NOT for writing actual docs (use tasks-documentation instead).
Guide documentation structure, README content, and project documentation best practices.Use when: creating README, documentation, docs folder, project setup.Keywords: README, docs, documentation, CONTRIBUTING, CHANGELOG, 文件, 說明文件.
Writing effective code documentation - API docs, README files, inline comments, and technical guides. Use for documenting codebases, APIs, or writing developer guides.
Keep README files current with project changes. Use when project structure changes, features added, or setup instructions modified. Suggests README updates based on code changes. Triggers on significant project changes, new features, dependency changes.
Readme Generator - Auto-activating skill for DevOps Basics.Triggers on: readme generator, readme generatorPart of the DevOps Basics skill category.
