documentation

Automate API and architecture documentation with Markdown templates and frontmatter metadata.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/emanuelrechsteiner/FairSplit --skill documentation-emanuelrechsteiner
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/emanuelrechsteiner/FairSplit/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/emanuelrechsteiner/FairSplit --skill documentation-emanuelrechsteiner

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is essential to ensure consistent, accessible, and maintainable software knowledge across teams. This Skill helps create and uphold API docs, architecture notes, developer guides, JSDoc comments, README updates, and Storybook stories, reducing knowledge gaps and onboarding time.

Core Features & Use Cases

  • Generate and maintain API documentation for functions, classes, and components.
  • Create architecture and developer guides, Storybook stories, and README improvements.
  • Use Case: A new module is added; generate API references, setup guides, and contribution docs.

Quick Start

Provide a complete API documentation package for a new module, including API references, guides, and contributor notes.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I generate API documentation for a new software module?

To generate API documentation for a new module, provide the codebase to automatically create API references, developer guides, and contributor notes. This process standardizes documentation types using Markdown templates and frontmatter-driven metadata.

What is the best way to maintain architecture documentation across a development team?

Maintaining architecture documentation is done by automating the creation and upkeep of architecture notes and developer guides. This ensures consistent, accessible, and maintainable software knowledge across teams.

Can I use Markdown templates for standardizing developer guides and API references?

Yes, you can use Markdown templates with frontmatter-driven metadata to standardize developer guides and API references. This ensures consistent formatting for architecture notes and onboarding guides across codebases.

Does this approach work for generating Storybook stories and JSDoc comments?

Yes, this approach works for generating Storybook stories and JSDoc comments. It helps create and uphold these documentation types alongside API references and README updates to reduce knowledge gaps.

When do I need to update README files and onboarding guides for my codebase?

You need to update README files and onboarding guides when a new module is added or updated. Automating this process generates setup guides, API references, and contribution docs to reduce onboarding time.