Skip to content

SpillwaveSolutions/document-specialist-skill / skills/documentation-specialist

documentation-specialist

Verified

This skill should be used when creating professional software documentation (SRS, PRD, OpenAPI, SDD, architecture docs, user manuals, tutorials, runbooks) from templates (greenfield) or reverse-engineering documentation from existing code like Spring Boot or FastAPI (brownfield). Also handles documentation audits/reviews, format conversion (Markdown, DOCX, PDF), and diagram generation (Mermaid first: C4, sequence, class, ER, state, flowchart; PlantUML Salt for UI wireframes and leftover UML). Use when asked to "create documentation", "document my code", "write SRS", "generate PRD", "write DESIGN_DOC.md", "architecture document", "wireframe", or "documentation specialist".

FileKindSize
SKILL.mdskill md10.0 KB
references/examples/TOC.mdmarkdown6.5 KB
references/examples/brownfield/database-failover-runbook.mdmarkdown8.1 KB
references/examples/brownfield/spring-boot-sdd.mdmarkdown5.6 KB
references/examples/greenfield/adr-microservices.mdmarkdown6.3 KB
references/examples/greenfield/architecture-doc.mdmarkdown3.7 KB
references/examples/greenfield/billing-srs.mdmarkdown12.4 KB
references/examples/greenfield/cli-getting-started.mdmarkdown9.3 KB
references/examples/greenfield/collaboration-prd.mdmarkdown13.8 KB
references/examples/greenfield/document-specialist-sdd.mdmarkdown15.4 KB
references/examples/greenfield/ecommerce-sdd.mdmarkdown7.8 KB
references/examples/greenfield/rest-api-tutorial.mdmarkdown13.8 KB
references/examples/greenfield/task-api-openapi.yamlconfig19.0 KB
references/examples/greenfield/taskmanager-user-manual.mdmarkdown8.7 KB
references/examples/greenfield/ui-wireframes.mdmarkdown5.8 KB
references/guides/requirements/README.mdmarkdown3.7 KB
references/mappings/backend/fastapi-mapping.yamlconfig9.7 KB
references/mappings/backend/spring-boot-mapping.yamlconfig24.1 KB
references/reference/01-philosophy.mdmarkdown2.0 KB
references/reference/02-requirements-srs-vs-prd.mdmarkdown1.2 KB
references/reference/02-requirements-traceability.mdmarkdown1.7 KB
references/reference/02-requirements-writing.mdmarkdown1.4 KB
references/reference/03-design-adrs.mdmarkdown2.2 KB
references/reference/03-design-arc42.mdmarkdown2.6 KB
references/reference/03-design-requirements-matrix.mdmarkdown1.3 KB
references/reference/04-diagrams-c4-hierarchy.mdmarkdown2.0 KB
references/reference/04-diagrams-selection.mdmarkdown5.1 KB
references/reference/04-diagrams-state-vs-activity.mdmarkdown2.3 KB
references/reference/05-api-checklist.mdmarkdown2.0 KB
references/reference/05-api-openapi.mdmarkdown3.4 KB
references/reference/05-api-stripe-gold-standard.mdmarkdown1.8 KB
references/reference/06-deployment-diagrams.mdmarkdown1.8 KB
references/reference/06-deployment-documentation.mdmarkdown2.9 KB
references/reference/06-deployment-runbooks.mdmarkdown2.5 KB
references/reference/06-operational-docs.mdmarkdown2.7 KB
references/reference/07-user-kb-approach.mdmarkdown1.8 KB
references/reference/07-user-kb-template.mdmarkdown3.1 KB
references/reference/07-user-writing-style.mdmarkdown2.0 KB
references/reference/08-agile-process.mdmarkdown3.2 KB
references/reference/08-tutorial-writing.mdmarkdown7.4 KB
references/reference/09-code-to-docs-detection.mdmarkdown2.5 KB
references/reference/09-code-to-docs-example.mdmarkdown3.2 KB
references/reference/09-code-to-docs-when.mdmarkdown1.7 KB
references/reference/09-code-to-docs-workflow.mdmarkdown2.0 KB
references/reference/10-quality-bonsai-pruning.mdmarkdown2.4 KB
references/reference/10-quality-checklist.mdmarkdown2.6 KB
references/reference/10-quality-metrics.mdmarkdown3.1 KB
references/reference/11-voice-and-style.mdmarkdown1.5 KB
references/reference/comprehensive-guide.mdmarkdown7.3 KB
references/templates/markdown/DESIGN_DOC.mdmarkdown4.5 KB
references/templates/markdown/api-openapi.yamlconfig17.7 KB
references/templates/markdown/architecture.mdmarkdown1.6 KB
references/templates/markdown/design-sdd.mdmarkdown143 B
references/templates/markdown/developer-tutorial.mdmarkdown7.1 KB
references/templates/markdown/getting-started.mdmarkdown6.5 KB
references/templates/markdown/howto-guide.mdmarkdown4.1 KB
references/templates/markdown/requirements-prd.mdmarkdown10.2 KB
references/templates/markdown/requirements-srs.mdmarkdown17.0 KB
references/templates/markdown/runbook.mdmarkdown8.8 KB
references/templates/markdown/user-manual.mdmarkdown4.8 KB
references/workflows/TOC.mdmarkdown1.9 KB
references/workflows/audit-workflow.mdmarkdown2.5 KB
references/workflows/brownfield-workflow.mdmarkdown3.6 KB
references/workflows/brownfield/fastapi-guide.mdmarkdown1.8 KB
references/workflows/brownfield/pulumi-guide.mdmarkdown1.9 KB
references/workflows/brownfield/springboot-guide.mdmarkdown2.2 KB
references/workflows/convert-workflow.mdmarkdown1.4 KB
references/workflows/design-workflow.mdmarkdown3.0 KB
references/workflows/diagram-workflow.mdmarkdown3.7 KB
references/workflows/greenfield-workflow.mdmarkdown3.4 KB
references/workflows/greenfield/advanced.mdmarkdown1.9 KB
references/workflows/greenfield/openapi-guide.mdmarkdown2.5 KB
references/workflows/greenfield/prd-guide.mdmarkdown2.0 KB
references/workflows/greenfield/srs-guide.mdmarkdown2.0 KB
references/workflows/runbook-workflow.mdmarkdown2.4 KB
references/workflows/tutorial-workflow.mdmarkdown2.3 KB
references/workflows/user-docs-workflow.mdmarkdown2.3 KB

references/examples/greenfield/taskmanager-user-manual.md

View on GitHub
# TaskMaster Pro User Manual

**Version**: 3.2.0
**Last Updated**: January 18, 2025
**Author**: TaskMaster Documentation Team

---

## Table of Contents
1. [Introduction](#introduction)
2. [Getting Started](#getting-started)
3. [Features](#features)
4. [Troubleshooting](#troubleshooting)
5. [FAQ](#faq)
6. [Support](#support)

---

## Introduction

### What is TaskMaster Pro?
TaskMaster Pro is a collaborative task management platform designed to help teams organize projects, track progress, and meet deadlines efficiently. With real-time updates, customizable workflows, and powerful reporting, TaskMaster Pro keeps your team aligned and productive.

### Who Should Use This Manual?
This manual is for end-users (team members, project managers, and administrators) who want to learn how to use TaskMaster Pro effectively.

### Document Scope
This manual covers:
- ✅ Creating and managing tasks
- ✅ Team collaboration features
- ✅ Project boards and workflows
- ✅ Reporting and analytics
- ❌ API integration (see Developer Guide)
- ❌ Enterprise administration (see Admin Guide)

---

## Getting Started

### Prerequisites
Before you begin, ensure you have:
- [ ] An active TaskMaster Pro account
- [ ] Modern web browser (Chrome 90+, Firefox 88+, Safari 14+)
- [ ] Team invitation link (for joining existing workspace)

### First-Time Setup

#### Step 1: Create Your Account
1. Navigate to https://taskmaster.pro/signup
2. Enter your email address and create a strong password
3. Verify your email by clicking the link sent to your inbox

#### Step 2: Set Up Your Profile
1. Click your avatar in the top-right corner
2. Select "Profile Settings"
3. Add your name, photo, and time zone
4. Click "Save Changes"

**✅ Verification**: Your profile photo should now appear in the top-right corner.

#### Step 3: Join or Create a Workspace
**To join existing workspace**:
1. Click the invitation link from your team
2. Accept the invitation

**To create new workspace**:
1. Click "Create Workspace" from dashboard
2. Enter workspace name and description
3. Invite team members by email

### Quick Start Guide (5 Minutes)
To get productive immediately:
1. **Create your first task**: Click "+ New Task", add title and due date
2. **Assign it**: Click task → Select assignee from dropdown
3. **Track progress**: Drag task between "To Do", "In Progress", "Done" columns

---

## Features

### Feature 1: Task Management

#### Overview
Tasks are the core building blocks of TaskMaster Pro. Each task can have a title, description, assignee, due date, priority, tags, and attachments.

#### How to Create a Task
1. **Open your project board**:
   - Click "Projects" in left sidebar
   - Select the project you want to add a task to

2. **Create the task**:
   - Click the "+ New Task" button
   - Fill in task details:
     - **Title**: Brief description (e.g., "Design landing page")
     - **Description**: Detailed requirements (supports Markdown)
     - **Assignee**: Team member responsible
     - **Due Date**: Target completion date
     - **Priority**: High, Medium, or Low
     - **Tags**: Optional labels (e.g., "design", "urgent")

3. **Save the task**:
   - Click "Create Task"
   - Task appears in "To Do" column

#### Common Use Cases
- **Bug tracking**: Use "bug" tag and High priority
- **Feature requests**: Link to design documents in description
- **Recurring tasks**: Use task templates (see Templates section)

#### Tips & Best Practices
💡 **Tip**: Use Markdown in descriptions for formatting:
```markdown
## Requirements
- [ ] Responsive design
- [ ] Mobile-first
- [ ] Accessibility (WCAG 2.1)
```

⚠️ **Warning**: Tasks deleted from "Done" column are permanently removed after 30 days.

---

### Feature 2: Project Boards

#### Overview
Project boards visualize your team's workflow using customizable columns. Move tasks between columns to track progress from start to finish.

#### How to Create a Project Board
1. **Navigate to Projects**:
   - Click "Projects" in sidebar
   - Click "+ New Project"

2. **Configure your board**:
   - **Name**: Project name
   - **Template**: Choose workflow template:
     - **Kanban**: To Do → In Progress → Done
     - **Scrum**: Backlog → Sprint → In Progress → Review → Done
     - **Custom**: Create your own columns
   - **Members**: Add team members

3. **Create the board**:
   - Click "Create Project"
   - Customize columns by clicking "Board Settings"

#### Advanced Options
For power users:
- **Automation**: Auto-move tasks when status changes
- **Swim Lanes**: Group tasks by assignee or priority
- **WIP Limits**: Set maximum tasks per column

---

### Feature 3: Real-Time Collaboration

#### Overview
TaskMaster Pro updates in real-time. See changes as teammates edit tasks, move cards, or add comments.

#### How to Collaborate
1. **Comments**:
   - Click any task
   - Type comment in text box
   - Mention teammates with `@username`
   - Attach files by drag-and-drop

2. **Activity Feed**:
   - View all project activity in right sidebar
   - Filter by team member or action type

3. **Notifications**:
   - Get notified when:
     - You're mentioned in a comment
     - Task assigned to you
     - Due date approaching
   - Configure in Settings → Notifications

#### Tips
💡 Use `@all` to notify entire team
💡 Reactions (👍 ❤️ 🎉) provide quick feedback

---

## Troubleshooting

### Common Issues

#### Issue: Can't See Tasks in Project
**Symptoms**: Project board appears empty
**Cause**: Filter settings hiding tasks
**Solution**:
1. Click "Filter" button in top-right
2. Reset filters: Click "Clear All"
3. Tasks should now be visible

**Prevention**: Check filter status indicator in toolbar

---

#### Issue: Task Not Updating in Real-Time
**Symptoms**: Changes made by teammates not appearing
**Cause**: Browser cache or network connectivity
**Solution**:
1. Refresh page (Ctrl+R / Cmd+R)
2. Check internet connection
3. Clear browser cache: Settings → Privacy → Clear Cache

---

#### Issue: Can't Upload Attachments
**Symptoms**: "Upload failed" error message

| Error Message | Cause | Solution |
|---------------|-------|----------|
| "File too large" | File > 25MB | Compress file or use cloud link |
| "File type not supported" | Executable files blocked | Upload as .zip or link to cloud storage |
| "Quota exceeded" | Workspace storage full | Upgrade plan or delete old files |

---

## FAQ

### General Questions

**Q: Is there a mobile app?**
A: Yes! Download TaskMaster Pro from App Store (iOS) and Google Play (Android).

**Q: Can I work offline?**
A: Yes, changes sync when you reconnect. Tasks show offline indicator (📴).

**Q: How many projects can I create?**
A: Depends on plan:
- Free: 3 projects
- Pro: 25 projects
- Enterprise: Unlimited

### Account & Billing

**Q: How do I upgrade my plan?**
A: Settings → Billing → Select new plan → Confirm

**Q: Can I cancel anytime?**
A: Yes, cancel in Settings → Billing. Access continues until period end.

### Technical Questions

**Q: What browsers are supported?**
A:
- ✅ Chrome 90+
- ✅ Firefox 88+
- ✅ Safari 14+
- ✅ Edge 90+

---

## Support

### Getting Help

**Documentation Resources**:
- 📘 User Manual (this document)
- 📗 [Video Tutorials](https://taskmaster.pro/learn)
- 📙 [API Documentation](https://api.taskmaster.pro/docs)
- 🎓 [TaskMaster Academy](https://academy.taskmaster.pro)

**Contact Support**:
- **Email**: support@taskmaster.pro
- **Phone**: 1-800-TASK-PRO (Mon-Fri 9AM-6PM EST)
- **Live Chat**: Click chat icon in bottom-right
- **Help Center**: https://help.taskmaster.pro

**Response Times**:
- Free: 48 hours
- Pro: 24 hours
- Enterprise: 4 hours (priority support)

### Community Resources
- **Forum**: https://community.taskmaster.pro
- **Feature Requests**: https://ideas.taskmaster.pro
- **Status Page**: https://status.taskmaster.pro
- **Twitter**: [@TaskMasterPro](https://twitter.com/taskmasterpro)

---

## Appendix

### Glossary
- **Board**: Visual workspace containing tasks organized in columns
- **Sprint**: Time-boxed period for completing tasks (Scrum methodology)
- **Tag**: Label for categorizing tasks (e.g., "bug", "feature")
- **Workspace**: Top-level container for teams and projects
- **WIP Limit**: Work In Progress limit - maximum tasks allowed in a column

### Keyboard Shortcuts
| Action | Windows/Linux | macOS |
|--------|---------------|-------|
| New Task | Ctrl+N | Cmd+N |
| Search | Ctrl+K | Cmd+K |
| Quick Switch Project | Ctrl+P | Cmd+P |
| Toggle Sidebar | Ctrl+\\ | Cmd+\\ |

### Version History
| Version | Date | Changes |
|---------|------|---------|
| 3.2.0 | Jan 2025 | Added automation rules, swim lanes |
| 3.1.0 | Dec 2024 | Real-time collaboration improvements |
| 3.0.0 | Nov 2024 | New UI redesign, dark mode |

---

**© 2025 TaskMaster Technologies Inc. All rights reserved.**
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall