{
  "schemaVersion": "1.0",
  "item": {
    "slug": "project-documentation",
    "name": "Project Documentation",
    "source": "tencent",
    "type": "skill",
    "category": "效率提升",
    "sourceUrl": "https://clawhub.ai/wpank/project-documentation",
    "canonicalUrl": "https://clawhub.ai/wpank/project-documentation",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadMode": "redirect",
    "downloadUrl": "/downloads/project-documentation",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=project-documentation",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "installMethod": "Manual import",
    "extraction": "Extract archive",
    "prerequisites": [
      "OpenClaw"
    ],
    "packageFormat": "ZIP package",
    "includedAssets": [
      "README.md",
      "SKILL.md"
    ],
    "primaryDoc": "SKILL.md",
    "quickSetup": [
      "Download the package from Yavira.",
      "Extract the archive and review SKILL.md first.",
      "Import or place the package into your OpenClaw setup."
    ],
    "agentAssist": {
      "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
      "steps": [
        "Download the package from Yavira.",
        "Extract it into a folder your agent can access.",
        "Paste one of the prompts below and point your agent at the extracted folder."
      ],
      "prompts": [
        {
          "label": "New install",
          "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete."
        },
        {
          "label": "Upgrade existing",
          "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run."
        }
      ]
    },
    "sourceHealth": {
      "source": "tencent",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-30T16:55:25.780Z",
      "expiresAt": "2026-05-07T16:55:25.780Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network",
        "contentDisposition": "attachment; filename=\"network-1.0.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null
      },
      "scope": "source",
      "summary": "Source download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this source.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/project-documentation"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    },
    "downloadPageUrl": "https://openagent3.xyz/downloads/project-documentation",
    "agentPageUrl": "https://openagent3.xyz/skills/project-documentation/agent",
    "manifestUrl": "https://openagent3.xyz/skills/project-documentation/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/project-documentation/agent.md"
  },
  "agentAssist": {
    "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
    "steps": [
      "Download the package from Yavira.",
      "Extract it into a folder your agent can access.",
      "Paste one of the prompts below and point your agent at the extracted folder."
    ],
    "prompts": [
      {
        "label": "New install",
        "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete."
      },
      {
        "label": "Upgrade existing",
        "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run."
      }
    ]
  },
  "documentation": {
    "source": "clawhub",
    "primaryDoc": "SKILL.md",
    "sections": [
      {
        "title": "Project Documentation (Meta-Skill)",
        "body": "Complete workflow for setting up and maintaining project documentation."
      },
      {
        "title": "OpenClaw / Moltbot / Clawbot",
        "body": "npx clawhub@latest install project-documentation"
      },
      {
        "title": "When to Use",
        "body": "Starting a new project and need docs structure\nImproving documentation on existing project\nSetting up ADRs, PRDs, or persona docs\nWant consistent documentation across projects"
      },
      {
        "title": "Docs-First Philosophy",
        "body": "Start every project with documentation, not code:\n\n1. Define the idea      → What is this? What problem does it solve?\n2. Define the personas  → Who uses this? What are their journeys?\n3. Define the features  → What does it do for each persona?\n4. Define the stack     → What technologies? Why?\n5. Then build           → With full context established"
      },
      {
        "title": "Directory Structure",
        "body": "docs/\n├── architecture/        # CURRENT STATE - Living docs of actual code\n│   ├── overview.md\n│   └── data-flow.md\n├── guides/              # CURRENT STATE - How to use/operate\n│   ├── getting-started.md\n│   └── configuration.md\n├── runbooks/            # CURRENT STATE - Short, actionable guides\n│   ├── local-dev.md\n│   ├── deploy.md\n│   └── database.md\n├── planning/            # FUTURE - Not for docs site\n│   ├── roadmap.md\n│   └── specs/\n├── decisions/           # ADRs - Decision records\n│   ├── 001-tech-stack.md\n│   └── 002-auth-approach.md\n└── product/             # PRD, personas\n    ├── overview.md\n    ├── personas/\n    └── features.md"
      },
      {
        "title": "Critical Separation: Current vs Future",
        "body": "CategoryPurposeGoes on Docs Site?Current StateHow things work nowYesPlanningFuture specs, designsNoArchitectureLiving docs of codeYesRoadmap/TodosWhat we're working onNoRunbooksHow to operateYesProposed RunbooksFuture plansNo"
      },
      {
        "title": "Architecture Decision Records (ADRs)",
        "body": "Template:\n\n# ADR-001: [Title]\n\n## Status\n[Proposed | Accepted | Deprecated | Superseded]\n\n## Context\n[What is the issue we're solving?]\n\n## Decision\n[What did we decide?]\n\n## Consequences\n[What are the results - positive and negative?]\n\n## Alternatives Considered\n[What other options did we evaluate?]"
      },
      {
        "title": "Product Requirements Document (PRD)",
        "body": "Template:\n\n# PRD: [Feature Name]\n\n## Problem\n[What problem are we solving?]\n\n## Users\n[Which personas does this serve?]\n\n## Requirements\n- [ ] Requirement 1\n- [ ] Requirement 2\n\n## Non-Goals\n[What are we explicitly NOT doing?]\n\n## Success Metrics\n[How do we know this worked?]"
      },
      {
        "title": "Persona Documentation",
        "body": "Template:\n\n# Persona: [Name]\n\n## Who They Are\n- Background\n- Technical level\n- Goals\n\n## Pain Points\n- [Pain 1]\n- [Pain 2]\n\n## Journey\n1. Discovery\n2. Onboarding\n3. Daily use\n4. Advanced usage\n\n## Content Needs\n- Doc types they need\n- Format preferences"
      },
      {
        "title": "Runbooks",
        "body": "Template:\n\n# Runbook: [Task Name]\n\n## Prerequisites\n- [Requirement 1]\n- [Requirement 2]\n\n## Steps\n1. [Step 1]\n2. [Step 2]\n\n## Verify\n[How to confirm success]\n\n## Troubleshooting\n| Problem | Solution |\n|---------|----------|\n| [Issue] | [Fix] |"
      },
      {
        "title": "Roadmap Format",
        "body": "## Roadmap\n\n### Current Sprint\n- [ ] Add user authentication endpoint\n- [ ] Create login form component\n- [ ] Wire form to auth endpoint\n\n### Backlog\n- [ ] Password reset flow\n- [ ] OAuth integration\n- [ ] Two-factor auth"
      },
      {
        "title": "Quality Gates",
        "body": "Before shipping docs:\n\nSeparates current state from planning\n Uses appropriate template for doc type\n Written for the right audience\n Actionable (runbooks) or explanatory (guides)\n No stale/outdated information"
      },
      {
        "title": "Anti-Patterns",
        "body": "Mixing future plans with current state — Confuses what's real\nPlanning docs on docs site — Users expect reality\nOne-size-fits-all docs — Different audiences need different depth\nBuilding features before personas — No context for decisions\nDocumentation written once and forgotten — Keep it current"
      },
      {
        "title": "Checklist for New Projects",
        "body": "Create docs/ directory structure\n Write initial PRD/overview\n Document 2-3 personas\n Create ADR-001 for tech stack\n Set up roadmap format\n Create essential runbooks (local-dev, deploy)\n Separate planning/ from current-state docs"
      },
      {
        "title": "Related Skills",
        "body": "Commands: /bootstrap-docs, /new-feature\nAgent: development"
      }
    ],
    "body": "Project Documentation (Meta-Skill)\n\nComplete workflow for setting up and maintaining project documentation.\n\nInstallation\nOpenClaw / Moltbot / Clawbot\nnpx clawhub@latest install project-documentation\n\nWhen to Use\nStarting a new project and need docs structure\nImproving documentation on existing project\nSetting up ADRs, PRDs, or persona docs\nWant consistent documentation across projects\nDocs-First Philosophy\n\nStart every project with documentation, not code:\n\n1. Define the idea      → What is this? What problem does it solve?\n2. Define the personas  → Who uses this? What are their journeys?\n3. Define the features  → What does it do for each persona?\n4. Define the stack     → What technologies? Why?\n5. Then build           → With full context established\n\nDirectory Structure\ndocs/\n├── architecture/        # CURRENT STATE - Living docs of actual code\n│   ├── overview.md\n│   └── data-flow.md\n├── guides/              # CURRENT STATE - How to use/operate\n│   ├── getting-started.md\n│   └── configuration.md\n├── runbooks/            # CURRENT STATE - Short, actionable guides\n│   ├── local-dev.md\n│   ├── deploy.md\n│   └── database.md\n├── planning/            # FUTURE - Not for docs site\n│   ├── roadmap.md\n│   └── specs/\n├── decisions/           # ADRs - Decision records\n│   ├── 001-tech-stack.md\n│   └── 002-auth-approach.md\n└── product/             # PRD, personas\n    ├── overview.md\n    ├── personas/\n    └── features.md\n\nCritical Separation: Current vs Future\nCategory\tPurpose\tGoes on Docs Site?\nCurrent State\tHow things work now\tYes\nPlanning\tFuture specs, designs\tNo\nArchitecture\tLiving docs of code\tYes\nRoadmap/Todos\tWhat we're working on\tNo\nRunbooks\tHow to operate\tYes\nProposed Runbooks\tFuture plans\tNo\nDocumentation Types\nArchitecture Decision Records (ADRs)\n\nTemplate:\n\n# ADR-001: [Title]\n\n## Status\n[Proposed | Accepted | Deprecated | Superseded]\n\n## Context\n[What is the issue we're solving?]\n\n## Decision\n[What did we decide?]\n\n## Consequences\n[What are the results - positive and negative?]\n\n## Alternatives Considered\n[What other options did we evaluate?]\n\nProduct Requirements Document (PRD)\n\nTemplate:\n\n# PRD: [Feature Name]\n\n## Problem\n[What problem are we solving?]\n\n## Users\n[Which personas does this serve?]\n\n## Requirements\n- [ ] Requirement 1\n- [ ] Requirement 2\n\n## Non-Goals\n[What are we explicitly NOT doing?]\n\n## Success Metrics\n[How do we know this worked?]\n\nPersona Documentation\n\nTemplate:\n\n# Persona: [Name]\n\n## Who They Are\n- Background\n- Technical level\n- Goals\n\n## Pain Points\n- [Pain 1]\n- [Pain 2]\n\n## Journey\n1. Discovery\n2. Onboarding\n3. Daily use\n4. Advanced usage\n\n## Content Needs\n- Doc types they need\n- Format preferences\n\nRunbooks\n\nTemplate:\n\n# Runbook: [Task Name]\n\n## Prerequisites\n- [Requirement 1]\n- [Requirement 2]\n\n## Steps\n1. [Step 1]\n2. [Step 2]\n\n## Verify\n[How to confirm success]\n\n## Troubleshooting\n| Problem | Solution |\n|---------|----------|\n| [Issue] | [Fix] |\n\nRoadmap Format\n## Roadmap\n\n### Current Sprint\n- [ ] Add user authentication endpoint\n- [ ] Create login form component\n- [ ] Wire form to auth endpoint\n\n### Backlog\n- [ ] Password reset flow\n- [ ] OAuth integration\n- [ ] Two-factor auth\n\nQuality Gates\n\nBefore shipping docs:\n\n Separates current state from planning\n Uses appropriate template for doc type\n Written for the right audience\n Actionable (runbooks) or explanatory (guides)\n No stale/outdated information\nAnti-Patterns\nMixing future plans with current state — Confuses what's real\nPlanning docs on docs site — Users expect reality\nOne-size-fits-all docs — Different audiences need different depth\nBuilding features before personas — No context for decisions\nDocumentation written once and forgotten — Keep it current\nChecklist for New Projects\n Create docs/ directory structure\n Write initial PRD/overview\n Document 2-3 personas\n Create ADR-001 for tech stack\n Set up roadmap format\n Create essential runbooks (local-dev, deploy)\n Separate planning/ from current-state docs\nRelated Skills\nCommands: /bootstrap-docs, /new-feature\nAgent: development"
  },
  "trust": {
    "sourceLabel": "tencent",
    "provenanceUrl": "https://clawhub.ai/wpank/project-documentation",
    "publisherUrl": "https://clawhub.ai/wpank/project-documentation",
    "owner": "wpank",
    "version": "1.0.0",
    "license": null,
    "verificationStatus": "Indexed source record"
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/project-documentation",
    "downloadUrl": "https://openagent3.xyz/downloads/project-documentation",
    "agentUrl": "https://openagent3.xyz/skills/project-documentation/agent",
    "manifestUrl": "https://openagent3.xyz/skills/project-documentation/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/project-documentation/agent.md"
  }
}