跳到主要内容
知仓学习社ZHICANG

code-documentation-doc-generate

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagram…

执行命令联网无严重或高危命中sickn33/agentic-awesome-skills

它会碰到什么

扫了多少2 个文本文件,20 KB
它会碰到什么执行命令联网
命中总数4 处
命中统计严重 0 · 高 0 · 中 0 · 低 0

这一栏是扫描器报的事实,不是结论。命中多不等于有毒(安全工具、规则库、示例脚本本来就会包含危险写法),命中少也不等于干净。它和你手上的凭据、文件、网络有什么关系,需要你自己看。

技能内容

Compatibility and maintenance

Compatibility alias of documentation-generation-doc-generate; use that ID for new references when no existing contract requires this one. The full instructions and support files remain local so existing installations

continue to work offline. This is one shared procedure, not an additional capability.

Preserve the callable ID when an existing manifest or client configuration uses it.

Modified in AAS on 2026-09-05; original metadata and license notices are retained.

Automated Documentation Generation

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code. Generate API docs, architecture diagrams, user guides, and technical references using AI-powered analysis and industry best practices.

Use this skill when

  • Generating API, architecture, or user documentation from code
  • Building documentation pipelines or automation
  • Standardizing docs across a repository

Do not use this skill when

  • The project has no codebase or source of truth
  • You only need ad-hoc explanations
  • You cannot access code or requirements

Context

The user needs automated documentation generation that extracts information from code, creates clear explanations, and maintains consistency across documentation types. Focus on creating living documentation that stays synchronized with code.

Requirements

$ARGUMENTS

Instructions

  • Identify required doc types and target audiences.
  • Extract information from code, configs, and comments.
  • Generate docs with consistent terminology and structure.
  • Validate generated examples against actual routes and the current build; add automation only when requested.
  • If detailed examples are required, open resources/implementation-playbook.md.

Worked example and prerequisites

For an endpoint changed to return a cursor, inspect its implementation and test

fixtures, update the response example and pagination explanation, then run the existing

schema/doc build and the documented read-only call against a test fixture. Record

which commands actually ran. The bundled playbook contains incomplete integration

sketches, not an installed generator or tested project template.

Safety

  • Avoid exposing secrets, internal URLs, or sensitive data in docs.

Output Format

  • Documentation plan and artifacts to generate
  • File paths and tooling configuration
  • Assumptions, gaps, and follow-up tasks

Resources

  • resources/implementation-playbook.md for detailed examples and templates.

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

想直接用这个技能?

本站把开放许可(MIT / Apache 等)的技能按仓库打包整理到网盘,点一下转存到你自己的网盘,不用一个个从 GitHub 拉。许可未声明的技能只给原始仓库链接,不打包。

它属于哪个仓库

星标★ 46,490
本站分层T1
该仓技能数6676
原文件路径plugins/agentic-awesome-skills-claude/skills/code-documentation-doc-generate/SKILL.md

同一个仓库里的其他技能

看这个仓库的全部 6676 个技能

同名技能的其他版本

有 3 个不同仓库或目录里都有叫 code-documentation-doc-generate 的技能。它们内容并不相同,别混用: