docs-writter

Write, edit, and review Markdown documentation against style guidelines.

2|Updated Feb 27, 2026
One-click install
npx skills add https://github.com/jackonedev/agent_skills --skill docs-writter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writter
Source: https://github.com/jackonedev/agent_skills/tree/main/skills/docs-writter
Command: npx skills add https://github.com/jackonedev/agent_skills --skill docs-writter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Use this skill to write, review, and edit documentation across the docs directory or any Markdown file, ensuring consistency and clarity.

Core Features & Use Cases

  • Authoring & Editing: Create new documentation and refine existing Markdown content.
  • Review & Consistency: Check for clarity, accuracy, and alignment with the style guide and contribution processes.
  • Guided Workflow: Follows the project's CONTRIBUTING.md and maintains proper structure, links, and formatting.

Quick Start

Create a clear, concise update to the user guide for the new feature in the docs/ directory.

Frequently Asked Questions about docs-writter

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

FAQPage Schema
How do I enforce a style guide when writing Markdown documentation?

To enforce a style guide for Markdown documentation, configure your editing workflow to read rules from references/style-guide.md. This ensures all authored and reviewed docs maintain consistent formatting, structure, and clarity across the project.

Can I use this to review existing Markdown files for consistency?

Yes, you can review existing Markdown files for consistency by checking them against defined style guidelines and contribution processes. This validates clarity, formatting, and structural alignment within the docs directory.

What is the best way to automate documentation contributions in Markdown?

The best way to automate documentation contributions in Markdown is by following the project's CONTRIBUTING.md process. This guides authoring and editing tasks to ensure updates align with team workflows and style requirements.

Do I need a CONTRIBUTING.md file to author new documentation?

Yes, a CONTRIBUTING.md file is needed to author new documentation properly. It provides the necessary project workflow rules that guide how Markdown content is structured, reviewed, and submitted for consistency.

Why does my Markdown documentation lack consistency across the docs directory?

Markdown documentation lacks consistency across the docs directory when edits bypass the project style guide. Applying rules from references/style-guide.md during authoring and review enforces uniform structure and clarity.