agent-doc-writer

Analyze git diffs to recommend documentation updates with action items.

Updated Jul 13, 2024
One-click install
npx skills add https://github.com/bearbinary/Jarvy --skill agent-doc-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agent-doc-writer
Source: https://github.com/bearbinary/Jarvy/tree/main/.claude/skills/agent-doc-writer
Command: npx skills add https://github.com/bearbinary/Jarvy --skill agent-doc-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the process of determining and recommending necessary documentation updates based on code changes, ensuring that documentation stays current with development.

Core Features & Use Cases

  • Code Change Analysis: Evaluates git diffs to understand the nature and impact of code modifications.
  • Documentation Scope Assessment: Categorizes changes (New Feature, Bug Fix, Refactor, etc.) and recommends the appropriate level of documentation (Commit Message Only, Inline, README, Dedicated Doc File).
  • Use Case: After implementing a new feature, you can invoke this Skill to get a clear recommendation on whether to update the README, add inline comments, or create a new documentation file, along with suggested content.

Quick Start

Analyze the recent git diff and recommend documentation updates.

Frequently Asked Questions about agent-doc-writer

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

FAQPage Schema
How do I automate documentation updates based on git diffs?

You can automate documentation updates by analyzing git diffs to categorize code changes into types like New Feature or Bug Fix, which then determines the necessary documentation scope and generates structured content recommendations.

What is the best way to determine documentation scope for a new feature?

Determining documentation scope involves categorizing the code change to assess its impact, ranging from a simple commit message to updating a README or creating a dedicated documentation file with suggested content.

Can I get recommended action items for technical writing after a code review?

Yes, after a code review you can receive structured recommendations with specific action items and suggested content for maintaining technical documentation based on the analyzed code modifications.

How does code change analysis decide between inline comments and a dedicated doc file?

Code change analysis categorizes modifications into types like Refactor or Breaking Change to evaluate their impact, subsequently recommending the appropriate documentation level from inline comments to dedicated files.

Do I need to prepare my git diff in a specific format before analyzing code changes?

You need to provide a standard git diff output so the analysis can evaluate the nature and impact of your code modifications to recommend appropriate documentation updates.

Why should I automate technical writing recommendations for breaking changes?

Automating recommendations for breaking changes ensures your technical documentation stays current with development by identifying the required documentation scope and providing structured content suggestions.