document

Automate project documentation creation and maintenance with an Analyze-Draft-Apply workflow.

1|1|Updated Feb 28, 2024
One-click install
npx skills add https://github.com/jiyeol-lee/dotfiles --skill document-jiyeol-lee
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/jiyeol-lee/dotfiles/tree/main/.opencode/skills/document
Command: npx skills add https://github.com/jiyeol-lee/dotfiles --skill document-jiyeol-lee

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation and ongoing maintenance of project documentation, reducing manual effort and ensuring consistency across READMEs, API docs, changelogs, and architecture notes.

Core Features & Use Cases

  • Discover and analyze existing docs and project metadata to tailor outputs.
  • Draft README, API docs, changelog entries, and architecture diagrams that reflect the current project state.
  • Provide an approval workflow to apply changes only after user confirmation.

Quick Start

Ask to document this project to generate a draft README, changelog, and API docs for review.

Frequently Asked Questions about document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate project documentation like READMEs and changelogs?

You can automate project documentation by using a discovery workflow that reads existing docs, analyzes project metadata, and drafts READMEs, changelogs, and API docs for your review before applying updates.

What is the best way to maintain architecture guidance and API docs for a software project?

The best way to maintain architecture guidance and API docs is an automated discovery workflow that drafts updates reflecting the current project state, adapting to different languages and tooling while requiring user approval before applying changes.

Can I generate API documentation tailored to different programming languages and tooling?

Yes, you can generate API documentation tailored to different languages and tooling by analyzing project metadata and existing docs to draft outputs that reflect the current project state, followed by a user approval step.

How does the approval workflow work when updating existing project docs?

The approval workflow operates by drafting proposed documentation updates based on analyzed project metadata, ensuring changes are applied only after you review and explicitly confirm them during the apply phase.

Do I need existing documentation to use an automated project docs generator?

No, existing documentation is not required, but if present, the tool discovers and analyzes it along with project metadata to tailor the drafted READMEs, changelogs, and architecture notes to your current project state.