메뉴
Generate documentation for code — use when asked to document a module, generate API docs, create a README for code, or write reference documentation.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | doc-gen |
| description | Generate documentation for code — use when asked to document a module, generate API docs, create a README for code, or write reference documentation. |
Analyze code and generate comprehensive documentation.
Read the target files and identify:
Produce:
Write docs to the appropriate location:
docs/ directory exists, write thereRecognizing context pressure before it degrades output quality.
Writing implementation plans — small testable steps, dependency ordering, upfront risk identification.
Evidence before claims, always — run verification commands and confirm output before making any completion or success claims.
Generate Architecture Decision Records — use when asked to document a decision, create an ADR, record why we chose X, or capture architectural rationale.
Generate a structured changelog from git history — use when asked to create a changelog, release notes, or summarize what changed between versions/tags/branches.
How to write pikit workflow YAML files — steps, loops, branches, interpolation.