agentsclimarketplace

Documentation writing

Skill SofiaDT/https---github.com-SofiaDT-projectmanagerskills/skills/documentation-writing

When the user wants to write or improve project documentation. Use when the user says "I need to write specs," "runbook," "standard operating procedure," "process documentation," "I need to document this," "project docs," "how-to guide," or "technical documentation." For writing project briefs, see project-proposals or project-kickoff.From its SKILL.md

Install
npx -y skills add SofiaDT/https---github.com-SofiaDT-projectmanagerskills --skill documentation-writing

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

  • 1 stars1 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

SKILL.md

4.3 KB, as published. Nobody here has run it

Documentation Writing

You are an expert project manager. Your goal is to help the user write clear, well-structured project documentation that teams can actually use.


Documentation Types & Templates

Requirements Document

## Requirements Document — [Project Name]

**Version**: 1.0 | **Date**: [Date] | **Author**: [Name]

### Purpose
[One paragraph on why this doc exists]

### Functional Requirements
Each requirement should have an ID, description, and acceptance criteria.

| ID | Requirement | Acceptance Criteria |
|----|-------------|-------------------|
| FR-001 | [Functional requirement description] | [ ] User can [action], [ ] System returns [result] |
| FR-002 | | |

### Non-Functional Requirements
| ID | Requirement | Target |
|----|-------------|--------|
| NFR-001 | Performance | Page loads in <2s |
| NFR-002 | Availability | 99.9% uptime |

### Constraints & Assumptions
- [Constraint 1]
- [Assumption 1]

Standard Operating Procedure (SOP)

## SOP: [Process Name]

**Version**: 1.0 | **Last Updated**: [Date] | **Owner**: [Name]

### Purpose
[What is this process? When do we use it?]

### Scope
[Who does this? When? Any exceptions?]

### Prerequisites
- [Pre-condition 1]
- [Before you start, you need X]

### Step-by-Step Process

1. **[Step 1 - Title]**
   - Do X
   - Check for Y
   - If Z, then go to step 4

2. **[Step 2 - Title]**
   - Detailed instructions

### Decision Tree (if applicable)
- If [condition], then [action]
- If [other condition], then [other action]

### Tools & Systems Used
- [Tool 1]: [What you use it for]
- [System 1]: [How to access]

### Common Issues & Troubleshooting
| Issue | Solution |
|-------|----------|
| [Problem] | [Fix] |

### Escalation
If [warning sign], escalate to [person/team] by [method].

### Related Documents
- [Link to related SOP or process]

### Sign-Off
- Author: [Sign, Date]
- Reviewer: [Sign, Date]

Runbook (Operational)

## Runbook: [Process Name]

**Audience**: [Operations team / developers / support]
**Emergency? Call [Contact]**

### Quick Reference
[Key info if something is broken]

### Before You Start
- [ ] Check that [system] is accessible
- [ ] Have [tool/credentials] handy
- [ ] Notify [team] that you're starting

### Normal Run (Happy Path)
1. [Step 1]
2. [Step 2]

### If Something Goes Wrong
[Emergency troubleshooting]

### After You're Done
- [ ] Verify [outcome]
- [ ] Log results in [system]
- [ ] Update status dashboard

Playbook (Scenario-Based)

## Playbook: [Scenario Name]

**When to use**: [Describe the scenario]

### Goal
[What should happen by the end of this playbook]

### Players
| Role | Name | Contact |
|------|------|---------|
| Lead | [Name] | [Contact] |

### Steps
1. [Action]
2. [Action]

### Decision Points
- If [condition], follow Path A
- If [condition], follow Path B

### Success Criteria
- [ ] [Outcome 1 achieved]
- [ ] [Outcome 2 achieved]

Documentation Best Practices

PrincipleWhyHow
Audience firstDifferent people need different docsTailor language / detail for the reader
Up to dateOutdated docs are worse than no docsAssign an owner, review cadence
Version controlTrack changesV1.0, V1.1, V2.0 with date
Simple languageClarity > clevernessShort sentences, active voice
ExamplesShow, don't tellInclude screenshots, sample outputs
IndexableEasy to findUse headers, TOC, consistent naming
CentralizedOne source of truthStore in shared location (Wiki, Confluence, Notion)

Related Skills

  • project-proposals — requires clear written scopes
  • project-kickoff — project brief is key documentation
  • sprint-planning — sprint docs (acceptance criteria) need clarity
  • requirements-gathering — requirements become functional specs

Keep looking

Skills are one crate of 608,475. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.