doc-authoring

Create and update Markdown documentation files following DropFlow docs conventions.

Updated Mar 31, 2026
One-click install
npx skills add https://github.com/gengirish/dropflow --skill doc-authoring-gengirish
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-authoring
Source: https://github.com/gengirish/dropflow/tree/main/.cursor/skills/doc-authoring
Command: npx skills add https://github.com/gengirish/dropflow --skill doc-authoring-gengirish

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping project documentation consistent is hard: new pages get created with mismatched formats, updates skip changelogs, and new docs never get registered in the index. This Skill enforces DropFlow's documentation conventions so every doc in docs/ follows the same structure, naming, and formatting rules. ## Core Features & Use Cases - New Document Creation: Generates new docs with kebab-case filenames, the standard template, and automatic registration in docs/README.md. - Structured Updates: Adds or modifies sections in existing docs while preserving heading levels, table columns, and appending dated changelog entries. - Domain Templates: Provides ready-made entry templates for API reference endpoints, Prisma data models, workflow steps, and operational runbooks. - Use Case: After shipping a new bulk-import feature, ask the assistant to create docs/bulk-import-guide.md — it produces a properly formatted guide, registers it in the README, and includes a changelog entry. ## Quick Start Create a new documentation page for the shipping carriers integration in docs/ following the DropFlow conventions.

Frequently Asked Questions about doc-authoring

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

FAQPage Schema
How do I create a new documentation page for a project?▼

Choose a kebab-case filename in docs/, apply the standard template with a top-level title, summary, sections, and a changelog, then register the page as a link in docs/README.md under the Documentation section.

How should I document a new REST API endpoint in Markdown?▼

Add a table row with method, path, auth, query or body parameters, success response, HTTP status, and error codes. Follow with a body field table listing each field's name, type, requirement, and notes.

When should I create a new doc file versus update an existing one?▼

Update an existing file when the content fits its scope. Create a new file only when the topic is large enough to warrant its own page, such as a feature guide, integration doc, or runbook.

What Markdown formatting conventions should project docs follow?▼

Use one top-level heading, no heading deeper than level three, tables for structured data, mermaid blocks for diagrams, language tags on code fences, and inline code for paths, env vars, and commands.

Why is a changelog section important in documentation files?▼

A dated changelog entry records what changed and why, giving readers an audit trail. Every meaningful update should append an entry, creating the section at the end of the file if it does not exist.