home / skills / shotaiuchi / dotclaude / feature-doc

feature-doc skill

safe

This skill generates comprehensive API, user-facing, and code documentation for new features, ensuring accurate examples, clear guidance, and changelog updates.

npx playbooks add skill shotaiuchi/dotclaude --skill feature-doc

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

1.8 KB

---
name: feature-doc
description: >-
  Documentation for new features. Apply when creating or updating
  API documentation, user guides, inline code documentation, and
  changelog entries for new functionality.
user-invocable: false
---

# Doc Writer Implementation

Create documentation for newly implemented features.

## Implementation Checklist

### API Documentation
- Document all new endpoints with method, path, and description
- Verify request/response schema examples are accurate
- Check that error codes and their meanings are listed
- Ensure authentication requirements are documented
- Validate query parameter and header documentation

### User-Facing Docs
- Write usage guides with step-by-step instructions
- Verify examples are runnable and produce expected output
- Check for screenshots or diagrams where helpful
- Ensure prerequisites and setup steps are documented
- Validate troubleshooting section for common issues

### Code Documentation
- Add JSDoc/KDoc/docstring to all public interfaces
- Verify parameter and return type descriptions are accurate
- Check that complex algorithms include explanatory comments
- Ensure module-level documentation explains purpose and usage
- Validate inline comments for non-obvious logic

### Changelog & Release Notes
- Add entry to changelog following project format
- Verify breaking changes are clearly called out
- Check that migration instructions are provided if needed
- Ensure new feature descriptions are user-understandable
- Validate linked issue and PR references

## Output Format

Report implementation status:

| Status | Description |
|--------|-------------|
| Complete | Fully implemented and verified |
| Partial | Implementation started, needs remaining work |
| Blocked | Cannot proceed due to dependency or decision needed |
| Skipped | Not applicable to this feature |

Overview

This skill generates clear, consistent documentation for newly implemented features across APIs, user guides, code comments, and changelogs. It enforces a checklist-driven approach to ensure accuracy, usability, and traceability of every documentation artifact. Use it to streamline documentation tasks during feature development and releases.

How this skill works

The skill inspects new feature changes and applies a structured checklist to produce or update API docs, user-facing guides, inline code documentation, and changelog entries. It verifies schemas, examples, authentication details, setup steps, and migration guidance, and outputs a concise implementation-status report. The report labels each checklist area as Complete, Partial, Blocked, or Skipped to guide next steps.

When to use it

When adding new API endpoints or modifying existing ones
When delivering a feature that requires user instructions or runbooks
When implementing public-facing code changes that need docstrings or module notes
When preparing release notes, changelogs, or migration guides for a release
When validating documentation completeness before a release or PR merge

Best practices

Start documentation work alongside feature implementation to avoid rework
Include runnable examples and validate them in the target environment
Document authentication, error codes, and edge-case behaviors explicitly
Keep changelog entries user-focused and clearly call out breaking changes
Use consistent templates for API docs, guides, and code comments to simplify review

Example use cases

Documenting a new REST endpoint with method, path, schema examples, and error codes
Creating a quick-start guide and troubleshooting section for a shipped feature
Adding JSDoc/docstrings to public interfaces and explaining complex algorithms
Preparing release notes that include migration steps and linked PR/issue references
Validating that request/response examples and headers in API docs are accurate

FAQ

What does the implementation-status report cover?

It summarizes status for API docs, user-facing docs, code documentation, and changelog entries using Complete, Partial, Blocked, or Skipped labels.

How should breaking changes be documented?

Mark them clearly in the changelog and release notes, provide migration instructions, and call out affected interfaces and expected impacts.