Results for “readme”

Write clear, developer-friendly documentation — READMEs, API references, code comments, and changelog entries — tailored to the audience and the project's voice. Use when the user says "write docs", "document this API", "update the README", "add code comments", "changelog entry", or "explain this for contributors".

A technical writer who crafts clear, comprehensive documentation. Specializes in README files, API docs, architecture docs, and user guides.

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.

Write or maintain technical documentation — READMEs, runbooks, API references, architecture docs — that a specific reader can act on without asking follow-ups.

Audits top-level documentation against recent git history to detect drift, applies minimal edits, and opens a pull request.

Records architectural decisions and documentation to capture the context, constraints, and trade-offs behind codebase choices.

Refactors a Python script into a beginner-friendly project with clear comments and a complete markdown tutorial.

Post-ship documentation sync — updates README, CHANGELOG, AGENTS.md, ARCHITECTURE, and TODOS after a release. Ensures docs never drift from code. Run after /commit or /ship before closing a PR.

Use this skill for README, ADRs, runbooks, changelogs, decision records, operator docs. Trigger when the task involves programming work related to Documentation Adrs, production implementation, audits, debugging, strategy, or validation.

GitHub 开源贡献自动化技能：根据目标公司和岗位寻找活跃项目，优先扫描 typo、README、Markdown、坏链接和 formatting 等低门槛机会，自动 fork、改动、验证并提交 PR，合并后把 contribution graph 酥化为 /asu 可用的简历素材；当用户输入“/contributor”、想刷 GitHub 绿点、做 first contribution、批量找开源小活或把 PR 写进简历时使用。

Automatically generate clear, comprehensive documentation for codebases — including API references, inline docstrings, README files, and usage guides. Use when the user requests code documentation or provides relevant inputs for this workflow.

Writes documentation optimized for AI agent consumption, including SKILL.md, README, and API docs, using layered context hierarchies and RAG-friendly formatting.

Extract project vision and decisions from a user through iterative Q&A, then convert them into clear repo documentation (README, ADRs, lessons). Use when user asks to document ideas in their head.

Analyze existing code files to generate a project-specific coding standards document, with options for templates, README insertion, and inconsistency detection.

Build and review high-quality technical documentation, including agent instruction files and contributor-governance files, with support for audits, multilingual parity, and sub-agent orchestration.

Generates task-oriented technical documentation with progressive disclosure for READMEs, API docs, architecture docs, and security reports after reverse engineering, penetration testing, or CTF tasks.

Generate clear documentation for each task including technical descriptions, architecture diagrams, and usage guides. Use when documenting completed features, creating README files, writing API documentation, generating architecture diagrams, or maintaining project documentation. Ensures knowledge is preserved and accessible.

Turn rough notes, workshop content, or prompt dumps into compliant, publish-ready SKILL.md files that pass validation and integrate with repo documentation.

Convert the cited draft into a Strapi-ready package — clean markdown body + Strapi-shaped JSON payload + a README with paste/publish instructions. Pushes directly to Strapi via API when STRAPI_API_TOKEN is set. With --auto-publish (or BLOG_AGENT_AUTO_PUBLISH=1), publishes the article live (publishedAt = now) instead of as draft.

Writes Markdown documents and text-based Mermaid diagrams (flowcharts, sequence, class, ER, gantt, state, and more) with full style guides, 24 diagram-type references, and 9 document templates. Use when authoring a scientific document, report, analysis, or README, or when a diagram should be expressed as version-controllable Mermaid/Markdown text rather than a rendered image. For AI-rendered publication schematics use scientific-schematics instead. Part of the AlterLab Academic Skills suite.