writing-user-docs

Create admin and user guides with structured procedures and cross-links.

107|81|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/fullsend-ai/fullsend --skill writing-user-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: writing-user-docs
Source: https://github.com/fullsend-ai/fullsend/tree/main/skills/writing-user-docs
Command: npx skills add https://github.com/fullsend-ai/fullsend --skill writing-user-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Administrators and developers often struggle to maintain consistent, accessible, and up-to-date user-facing documentation across repos. This skill provides a structured approach and rules to write clear docs that align with project standards.

Core Features & Use Cases

  • Provides a directory layout for guides under docs/guides/ with separate admin and user guides, plus writing rules and best practices.
  • Enforces a single-audience per guide and prerequisites, with step-oriented procedures and inline linking to ADRs and architecture docs.
  • Use Case: when updating onboarding or workflow guides, this skill standardizes tone, structure, and citations.

Quick Start

Create a new admin guide under docs/guides/admin/install-fullsend.md following the defined structure.

Frequently Asked Questions about writing-user-docs

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

FAQPage Schema
How do I structure admin and user documentation consistently across GitHub repos?

To structure admin and user documentation consistently, organize guides under docs/guides/ with separate admin and user folders, enforcing a single audience per file with step-oriented procedures and inline links to architecture docs.

What is the best way to write step-by-step installation guides for developers?

The best way to write installation guides is using step-oriented procedures that explicitly list prerequisites and cross-link to ADRs and architecture docs. This ensures developers have the necessary context and environment setup before proceeding.

How do I separate audiences when writing user guides and admin guides?

You separate audiences by enforcing a single-audience per guide rule, creating distinct user-facing and admin-facing documents. This ensures administrators get configuration details while users receive workflow instructions tailored to their access level.

Can I use a writing checklist to standardize developer handbooks in GitHub?

Yes, you can use a structured writing checklist to standardize developer handbooks in GitHub-hosted repos. The checklist enforces rules for prerequisites, step-based procedures, and cross-linking to architecture documentation.

When do I need to cross-link ADRs and architecture docs in my documentation?

You need to cross-link ADRs and architecture docs when writing configuration and workflow guides to provide decision context. This inline linking satisfies project standards by connecting procedural steps directly to architectural rationale.

What are the limitations of using predefined directory layouts for project documentation?

A limitation of using predefined directory layouts for project documentation is the strict enforcement of a single-audience per guide and specific structural rules. Projects requiring highly customized documentation flows may find these standardized constraints too rigid.