docs

Updates project documentation files to stay synchronized with code changes.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code changes frequently leave documentation stale, causing API references, data models, and deployment guides to drift out of sync with the actual codebase. This Skill enforces a rule that every change to a public contract must update the corresponding doc. ## Core Features & Use Cases - Change-to-Doc Mapping: Directs updates to the correct file in docs/ based on what changed, such as API routes, Prisma models, env vars, workflow steps, or deployment config. - Format Conventions: Standardizes docs with markdown tables, mermaid diagrams, inline code for paths, and changelog date-stamps. - Sync Verification Checklist: Provides a pre-PR checklist confirming endpoints, models, env vars, workflow steps, and user-facing features are documented. - Use Case: After adding a new API endpoint, the Skill walks you through updating docs/api-reference.md with method, path, auth, request/response schemas, and error codes, plus docs/data-model.md if a new model is involved. ## Quick Start Update the project documentation to reflect the new API endpoint and Prisma model I just added.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I keep documentation in sync with code changes?▼

Update the corresponding doc file whenever a public contract changes, such as API routes, Prisma models, env vars, or workflow steps. This Skill maps each change type to a specific file in the docs directory and provides a verification checklist before finishing a PR.

What documentation should I update after adding an API endpoint?▼

Update docs/api-reference.md with the method, path, auth requirements, request body schema, response shape, and error codes. If the endpoint touches a new database model, also update docs/data-model.md.

How do I document Prisma schema changes in a project?▼

Open docs/data-model.md and update the model table with new fields and enums. If the schema change is destructive, note the required migration steps in the same file.

What format conventions should project documentation follow?▼

Use markdown tables for structured data like endpoints and env vars, mermaid diagrams for architecture and data flow, and inline code for paths and field names. Date-stamp significant changes under a Changelog section in each doc.

When should environment variable changes be documented?▼

Document env var changes immediately in docs/deployment.md, including the name, whether it is required or optional, a description, and an example value. This keeps deployment and CI/CD configuration accurate.