skills.rest
acartine
acartineCOMMUNITY
Explore all skills by this author →
Website𝕏@acartineGitHub

documentation

Generate user-focused documentation that matches project conventions and supports TOC integration.

1|Updated Oct 19, 2025
Search Tags:#documentation#writing#markdown#codebase#patterns#examples#toc
One-click install
npx skills add https://github.com/acartine/osterman --skill documentation-acartine
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/acartine/osterman/tree/main/skills/documentation
Command: npx skills add https://github.com/acartine/osterman --skill documentation-acartine

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git.

What problem does it solve?

Documentation inconsistencies and scattered patterns slow onboarding and reduce usability; this Skill creates clear, well-placed documentation that aligns with project conventions.

Core Features & Use Cases

  • Explore existing documentation structure and patterns to learn the project style.
  • Create user-focused documentation that fits the project conventions, including examples and TOC integration.
  • Use case: add a new feature's user guide with cross-references and clear installation/setup instructions.

Quick Start

Create documentation for a new feature following project patterns.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I create user documentation that matches my existing project patterns?▼

To create user documentation that matches project patterns, you need a tool that analyzes your codebase and existing docs to learn your project's style. This Skill generates consistent, ready-to-publish content that aligns with your established conventions.

What is the best way to generate a table of contents and examples for a new feature guide?▼

Generating a table of contents and examples for a feature guide requires analyzing your existing documentation structure. This Skill automates that by creating user-focused content that supports TOC integration, cross-references, and example sections.

Do I need git to write documentation with this tool?▼

Yes, you need git installed in your environment to use this documentation tool. It relies on git to explore your codebase and existing documentation structure to learn your project's patterns and conventions.

Can I automatically format markdown documentation to fit my codebase conventions?▼

Yes, you can automatically format markdown documentation to fit your codebase conventions. The Skill explores your existing documentation patterns and generates content that matches your project's specific style and formatting rules.

How do I ensure my new feature documentation has correct cross-references and setup instructions?▼

To ensure your new feature documentation has correct cross-references and setup instructions, you should generate it based on existing project patterns. This Skill creates user-focused guides with clear installation steps and links.

Related Skills

Explore More Content & Communication Skills→
d0whc3rd0whc3r
2

speckit-git-initialize

Initialize a Git repository and create an initial commit.

Community
Intermediate
georgekhananaevgeorgekhananaev
27

md

Enforce consistent Markdown syntax across documentation and README files.

Community
Basic
CERTCCCERTCC
21

build-docs

Validate markdown documentation with strict mkdocs build checks.

Official
Intermediate
Andreicr1Andreicr1

api-documentation

Generate HTML, Markdown, and PDF API documentation from OpenAPI specs or code comments.

Community
Advanced