up-documentation

Generate auditable documentation bundles from UP artifacts.

3|Updated Mar 31, 2026
One-click install
npx skills add https://github.com/apolosan/unified_process_pi_extension --skill up-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: up-documentation
Source: https://github.com/apolosan/unified_process_pi_extension/tree/main/skills/up-documentation
Command: npx skills add https://github.com/apolosan/unified_process_pi_extension --skill up-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The UP documentation engine consolidates and publishes a complete, auditable documentation bundle from authoritative UP artifacts, enabling stakeholders, developers, operators, and users to access validated evidence and operational guidance.

Core Features & Use Cases

  • Generates executive summaries, traceability matrices, architecture guides, API guides, user manuals, deployment guides, and troubleshooting docs directly from UP artifacts.
  • Produces evidence-backed documentation: deployment reports, test results, and runtime health signals, all synchronized to the deployed system.
  • Use Cases: A deployment team regenerates deployment evidence and health checks after a release to ensure audits and compliance.

Quick Start

Configure and run the documentation pipeline to generate the complete UP documentation bundle from the project's artifacts.

Frequently Asked Questions about up-documentation

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

FAQPage Schema
How do I generate an auditable documentation bundle from project artifacts?

To generate an auditable documentation bundle from project artifacts, you configure and run the documentation pipeline to consolidate authoritative inputs into validated executive summaries, traceability matrices, and deployment guides ready for publication.

What is evidence-backed documentation in a deployment pipeline?

Evidence-backed documentation synchronizes deployment reports, test results, and runtime health signals directly from deployed system outputs. This ensures stakeholders and operators access validated operational guidance and compliance data.

Can I use MCP tooling integration to collect deployment evidence for traceability?

Yes, you can use MCP tooling integration to collect deployment evidence for traceability. The system applies this integration to gather runtime health signals and deployment outputs, ensuring synchronized, validated documentation.

Does diagram rendering work with mermaid when publishing UP documentation?

Yes, diagram rendering works with mermaid when publishing UP documentation. The pipeline applies diagram rendering where available to visually map architecture guides and traceability matrices from artifacts.

What is the best way to automate traceability matrix generation for stakeholders?

The best way to automate traceability matrix generation for stakeholders is to use a documentation engine that transforms authoritative artifacts directly into validated, structured matrices ready for publication.

When do I need to regenerate deployment evidence after a release?

You need to regenerate deployment evidence after a release when audits and compliance require updated records. Deployment teams use the pipeline to capture new health checks and synchronize outputs to the deployed system.