documentation

Guide authors through a structured workflow to create Squarelet product documentation.

11|14|Updated Jun 25, 2018
One-click install
npx skills add https://github.com/MuckRock/squarelet --skill documentation-muckrock
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/MuckRock/squarelet/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/MuckRock/squarelet --skill documentation-muckrock

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Product teams and support staff spend considerable time producing and updating end-user documentation. This skill provides a structured workflow to create, revise, and maintain user-focused docs for Squarelet/MuckRock Accounts, ensuring consistency and accuracy.

Core Features & Use Cases

  • Structured authoring workflow: Understand user needs, research features, outline content, and produce user-friendly docs.
  • Style and template guidelines: Follow established templates, tone, and formatting to ensure consistency across docs.
  • Save and organize: Place finalized pages under docs/product/ and maintain an index for easy discovery.
  • Use Case: Create getting-started guides, feature overviews, troubleshooting pages, and admin/user workflows.

Quick Start

Follow the documented workflow to create or update a user-facing page and save it to docs/product/.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write end-user product documentation in markdown?

Yes, this documentation workflow provides established templates and style guidelines to help you create getting-started tutorials, feature overviews, and troubleshooting references with consistent formatting and tone.

What is the best way to structure getting-started guides for users?

The best way to structure getting-started guides is to use a repeatable authoring workflow that outlines content based on user needs, applies style guidelines, and saves the organized pages under docs/product/ for easy discovery.

Does this documentation workflow enforce specific frontmatter and markdown structure?

Yes, the documentation workflow enforces specific frontmatter requirements and markdown structure to maintain consistency and accuracy across all feature guides and troubleshooting references.

How do I organize and maintain an index for product docs?

You organize and maintain a product docs index by saving finalized pages under docs/product/ and updating the index to ensure easy discovery of getting-started tutorials, feature guides, and troubleshooting references.

Can I use these documentation templates for troubleshooting references?

Yes, you can use the provided documentation templates for troubleshooting references. The workflow supports creating admin workflows, feature guides, and troubleshooting pages while maintaining consistent style and formatting.