code-generate-document

Generate missing documentation or architectural decision records (ADRs).

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "code-generate-document" with this command: npx skills add sirn/dotfiles/sirn-dotfiles-code-generate-document

Generate missing documentation or architectural decision records (ADRs).

Process

Identify context:

  • If code changes are involved: run jj diff -s first to see changed files

  • If the user specified specific files or paths, focus on those

Determine Documentation Type:

  • Inline Docs: Docstrings, comments for functions/classes

  • File/Module Docs: Top-level explanations (README.md updates)

  • ADR: Architecture Decision Record for design choices

Execute based on type:

Inline/Module Docs:

  • Read and understand the code

  • Check existing doc style (Google, NumPy, Javadoc, etc.)

  • Generate documentation that matches the project style

  • Action: Propose changes to files

ADR (Architecture Decision Record):

  • Ask user for: Context, Decision, Consequences (if not provided)

  • Format it correctly (Title, Status, Context, Decision, Consequences)

  • Action: Create new file in doc/adr/ (or project equivalent)

Output

  • Documentation Plan (what will be documented)

  • Generated Content (preview)

  • Changes Applied (file paths)

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Coding

code-explain

No summary provided by upstream source.

Repository SourceNeeds Review
16-sirn
Coding

code-config-ci

No summary provided by upstream source.

Repository SourceNeeds Review
16-sirn
Coding

code-quality

No summary provided by upstream source.

Repository SourceNeeds Review
16-sirn
Coding

code-plan

No summary provided by upstream source.

Repository SourceNeeds Review
16-sirn