Get the FREE Ultimate OpenClaw Setup Guide →

project-docs

Scanned
npx machina-cli add skill anilcancakir/claude-code-plugins/project-docs --openclaw
Files (1)
SKILL.md
5.7 KB

Project Documentation Skill

Patterns and templates for creating project briefs and product requirements documents (PRDs).

Purpose

Create non-technical project documentation that answers:

  • What is this project?
  • Who is it for?
  • Why does it exist?
  • What problem does it solve?

This is NOT technical documentation. For technical docs, use CLAUDE.md.

Project Brief vs PRD vs CLAUDE.md

DocumentPurposeAudience
project.mdProject identity and goalsStakeholders, team
brand.mdVisual and verbal identityDesigners, marketing
CLAUDE.mdTechnical configurationClaude Code

Project.md Structure

Minimal (MVP/Side Projects)

# [Project Name]

> [Tagline - one memorable sentence]

[2-3 sentence description]

## Problem

[What pain point does this solve?]

## Solution

[How does your project solve it?]

## Target User

[Who is this for?]

Standard (Startups/Products)

# [Project Name]

> [Tagline]

[Description]

## Problem

**What**: [The pain point]
**Who**: [Who experiences it]
**Impact**: [Cost of the problem]

## Solution

[Value proposition]

## Target Audience

**Primary User**: [Role and context]
- Technical level: [Level]
- Key goal: [What they want]

## Core Features

| Feature | Benefit |
|---------|---------|
| [Name] | [User value] |

## Success Metrics

| Metric | Target | Timeframe |
|--------|--------|-----------|
| [KPI] | [Goal] | [When] |

Comprehensive (Enterprise/Funded)

# [Project Name]

> [Tagline]

[Description]

## Executive Summary

[One paragraph overview for executives]

## Problem Statement

**Problem**: [Detailed pain point]
**Evidence**: [Data, research, quotes]
**Who**: [Target segment with size]
**Impact**: [Business cost if unsolved]

## Solution

**Value Proposition**:
For [TARGET USER]
who [NEED/PROBLEM],
[PROJECT NAME] is a [CATEGORY]
that [KEY BENEFIT].
Unlike [ALTERNATIVES],
we [UNIQUE DIFFERENTIATOR].

## Target Audience

### Primary Persona
- **Name**: [Persona name]
- **Role**: [Job title/context]
- **Goals**: [What they want to achieve]
- **Pains**: [Current frustrations]
- **Technical**: [Skill level]

### Secondary Persona
[Similar structure]

## Core Features

### MVP Features (Must Have)
| Feature | Benefit | Priority |
|---------|---------|----------|
| [Name] | [Value] | P0 |

### Future Features (Nice to Have)
| Feature | Benefit | Priority |
|---------|---------|----------|
| [Name] | [Value] | P1/P2 |

## Success Metrics

### Leading Indicators
- [Metric]: [Target] by [Date]

### Lagging Indicators
- [Metric]: [Target] by [Date]

## Market Context

[If market research was conducted]

### Competitive Landscape
| Competitor | Strength | Weakness | Our Advantage |
|------------|----------|----------|---------------|

### Market Size
- TAM: [Total Addressable Market]
- SAM: [Serviceable Addressable Market]
- SOM: [Serviceable Obtainable Market]

## Out of Scope

[What we're explicitly NOT building]

## Risks & Mitigation

| Risk | Impact | Mitigation |
|------|--------|------------|
| [Risk] | [High/Med/Low] | [How to address] |

Key Principles

1. Start with Why

  • Lead with the problem, not the solution
  • Show evidence of the pain point
  • Make the reader care

2. User-Centric Language

  • Features are benefits, not specs
  • Use "you" and "your"
  • Avoid technical jargon

3. Be Specific

  • "30% time savings" not "faster"
  • "Small business owners" not "users"
  • Concrete examples over abstractions

4. Action-Oriented

  • Each section should inform decisions
  • Include success metrics
  • Define clear scope

Anti-Patterns to Avoid

AvoidInstead
"Built with React""Instant, responsive interface"
"Uses PostgreSQL""Your data is secure and backed up"
"RESTful API""Integrates with your existing tools"
"Users""Small business owners"
"Better""50% faster invoice processing"

Feature Writing Guidelines

Good Feature Descriptions

## Smart Scheduling
Never miss a deadline. Our AI analyzes your workload and suggests
the optimal time to work on each task based on your energy patterns.

**Benefit**: Spend less time planning, more time doing.

Bad Feature Descriptions

## Smart Scheduling
Uses machine learning algorithms with TensorFlow to optimize task
scheduling based on historical data analysis and user behavior patterns.

[Too technical, no clear benefit]

Value Proposition Templates

For B2B SaaS

For [TARGET ROLE] at [COMPANY TYPE]
who struggle with [PAIN POINT],
[PRODUCT] is a [CATEGORY]
that [PRIMARY BENEFIT].
Unlike [COMPETITOR/ALTERNATIVE],
we [UNIQUE VALUE] because [REASON].

For Consumer Apps

[PRODUCT] helps [TARGET USER] [ACHIEVE GOAL]
by [HOW IT WORKS].

For Developer Tools

[PRODUCT]: [WHAT IT IS] that [KEY BENEFIT].
Stop [PAIN] and start [POSITIVE OUTCOME].

Integration with idea-research Plugin

If the idea-research plugin is installed, project.md can include:

  • Market Validation: SWOT analysis, idea scoring
  • Competitive Analysis: Competitor mapping, positioning
  • Market Sizing: TAM/SAM/SOM calculations
  • Trend Analysis: Timing assessment, growth drivers

Reference the idea-research agents for detailed market research.

References

For detailed templates and examples, see:

Source

git clone https://github.com/anilcancakir/claude-code-plugins/blob/main/project-optimizer/skills/project-docs/SKILL.mdView on GitHub

Overview

Provides templates and patterns for creating non-technical project briefs and PRDs. It guides what the project is, who it's for, why it exists, and the problems it solves, without diving into technical configuration. Use these structures to draft project.md, brand.md, and PRD documents that stakeholders can read easily.

How This Skill Works

Templates are organized into Minimal, Standard, and Comprehensive formats, each with defined sections (Problem, Solution, Target Audience, Core Features, Success Metrics, etc.). Fill in the sections to produce ready-to-share project documentation. The skill distinguishes between project documentation (non-technical) and CLAUDE.md (technical configuration).

When to Use It

  • Running /my_project to initialize project docs
  • Creating project briefs for new initiatives
  • Defining product requirements (PRDs) for non-technical audiences
  • Explaining value propositions and target audiences
  • Aligning stakeholders with project scope and goals

Quick Start

  1. Step 1: Run /my_project to generate project-docs templates
  2. Step 2: Pick Minimal, Standard, or Comprehensive format and fill required sections
  3. Step 3: Produce project.md, brand.md, or CLAUDE.md as needed and share with stakeholders

Best Practices

  • Start with Why: lead with the problem and evidence
  • Use user-centric language: focus on 'you' and 'your' benefits
  • Be specific: provide concrete metrics and examples
  • Be action-oriented: link sections to decisions and next steps
  • Define scope and success metrics up front

Example Use Cases

  • MVP mobile app project brief with Problem/Solution/Target Audience
  • Startup PRD outlining primary user and key KPIs
  • Enterprise project brief for a data tooling initiative
  • Non-technical brand/identity project brief
  • Internal tool upgrade documented with MVP features and success metrics

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers