docs-writer

Write, review, and edit documentation files using file system tools.

Updated Mar 6, 2026
One-click install
npx skills add https://github.com/gooftroop/Armoury --skill docs-writer-gooftroop
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-writer
Source: https://github.com/gooftroop/Armoury/tree/main/.opencode/skills/docs-writer
Command: npx skills add https://github.com/gooftroop/Armoury --skill docs-writer-gooftroop

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the creation, editing, and maintenance of project documentation, ensuring clarity, accuracy, and adherence to established standards.

Core Features & Use Cases

  • Content Creation: Write new documentation pages, guides, and tutorials.
  • Content Editing: Revise existing documentation for clarity, grammar, and technical accuracy.
  • Style Guide Adherence: Ensure all documentation follows the project's specific style and formatting guidelines.
  • Use Case: You need to update the installation guide for a new feature. This Skill can help you write the new steps, integrate them into the existing document, and ensure it matches the project's tone and formatting.

Quick Start

Use the docs-writer skill to edit the file 'README.md' to include instructions for setting up the development environment.

Frequently Asked Questions about docs-writer

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

FAQPage Schema
How do I write and edit markdown documentation for my project?

To edit markdown documentation within your project, this Skill reviews and refines content directly in the /docs directory or any .md file. It clarifies requests, investigates code to ensure accuracy, and applies changes using file system tools.

How do I ensure my technical writing follows a specific style guide?

To ensure your technical writing follows a specific style guide, this Skill checks your documentation against established contribution guidelines. It enforces formatting rules, proper linking, and consistent tone across all edited markdown artifacts.

What is the best way to update an existing README with new setup instructions?

The best way to update a README with new setup instructions is to use an automated documentation editor. This Skill writes new steps, integrates them into the existing markdown document, and ensures the text matches your project's tone and formatting.

Can I use this to review documentation for technical accuracy and clarity?

Yes, you can use this Skill to review documentation for technical accuracy and clarity. It investigates the underlying code to verify facts and revises existing markdown content to improve grammar, consistency, and overall readability.

Does this documentation editor work without external dependencies?

Yes, this documentation editor works without external dependencies. It operates autonomously using built-in file system tools to replace and write content, requiring only access to your project's markdown files and contribution guidelines.