docs-writer

Create and organize Markdown documentation in a project's docs/ directory.

Updated Apr 22, 2026
One-click install
npx skills add https://github.com/aroido/vibesmith --skill docs-writer-aroido
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/aroido/vibesmith/tree/main/.cursor/skills/docs-writer
Command: npx skills add https://github.com/aroido/vibesmith --skill docs-writer-aroido

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of creating, organizing, and updating project documentation within the docs/ directory, ensuring consistency and discoverability.

Core Features & Use Cases

  • Structured Document Creation: Guides users through creating new Markdown files with appropriate templates and naming conventions.
  • Categorization: Helps organize documents into logical categories (e.g., architecture/, api/, features/).
  • Duplicate Checking: Provides steps to verify if a document already exists or if content can be merged.
  • README Management: Assists in updating category and main README files to reflect new or modified documents.
  • Use Case: When a new API endpoint is developed, use this Skill to create a corresponding api/ document, ensuring it follows the standard template and is linked in the api/README.md.

Quick Start

Use the docs-writer skill to create a new document in the 'architecture' category with the title 'System Design Overview'.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I organize project documentation into categories like architecture and APIs?

Organizing project documentation involves sorting Markdown files into logical categories like `architecture/` and `api/` within your `docs/` directory. This process uses kebab-case filenames and category README files to ensure structured discoverability.

What is the best way to create structured Markdown documents for a new feature?

Creating structured Markdown documents for a new feature requires applying standardized templates within a `features/` directory. This approach checks for duplicate content and updates the category README to link the newly generated file.

How does kebab-case filename generation work for project documentation?

Kebab-case filename generation for project documentation converts document titles into lowercase words separated by hyphens. This creates consistent file paths within your `docs/` directory, preventing spacing issues and improving Markdown file organization.

How do I check for duplicate Markdown documents before creating a new file?

Checking for duplicate Markdown documents involves verifying existing files in your `docs/` directory before generating a new one. This step ensures content is not duplicated and allows for merging overlapping information into a single document.

How do I update README files to link newly created architecture documents?

Updating README files to link new architecture documents requires appending entries to the main and category READMEs within your `docs/` directory. This maintains accurate project documentation indexing and ensures new files are discoverable.