generate-impl-doc
CommunityDocument code changes with 5W1H.
Authordeneb-cygnus-dev
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill automates the generation of comprehensive implementation documentation for code branches, ensuring clarity and consistency before merging.
Core Features & Use Cases
- 5W1H Framework: Structures documentation around Who, What, When, Where, Why, and How.
- Automated Information Gathering: Collects branch name, diffs, commit history, and author information using Git commands.
- Directory Validation: Checks for the existence of the
docs/implementationsdirectory and prompts for creation if missing. - Use Case: After completing a new feature on a branch named
feature/user-profile-update, you can run this skill to generate a detailed markdown document indocs/implementations/feature-user-profile-update.mdthat explains the changes, their purpose, and how they were implemented.
Quick Start
Generate implementation documentation for the current branch using the 5W1H format.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: generate-impl-doc Download link: https://github.com/deneb-cygnus-dev/dot-agent/archive/main.zip#generate-impl-doc Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.