sdd-doc

Generate Markdown documentation with Mermaid diagrams for traced Data Manager flows.

Updated Mar 12, 2026
One-click install
npx skills add https://github.com/PixelDroid19/Data-Management-Analyst --skill sdd-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sdd-doc
Source: https://github.com/PixelDroid19/Data-Management-Analyst/tree/main/skills/sdd-doc
Command: npx skills add https://github.com/PixelDroid19/Data-Management-Analyst --skill sdd-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill transforms complex Data Manager (DM) investigations into clear, developer-facing documentation, ensuring that technical service logic and backend orchestrations are easily understood and maintained within the repository.

Core Features & Use Cases

  • Automated Documentation Generation: Creates Markdown documentation from traced DM flows, including service call chains, parameter mappings, and DM internals.
  • Repository Persistence: Saves generated documentation and diagrams into the project's docs/ directory.
  • Diagram Integration: Leverages sdd-design-doc-mermaid to generate technical diagrams (sequence, class) supporting the documentation.
  • Viewer Deployment: Deploys an interactive HTML viewer for the generated documentation.
  • Use Case: After investigating a complex Data Manager flow, use this Skill to automatically generate a comprehensive Markdown document with Mermaid diagrams, making it easy for new team members to understand the backend service interactions and the DM's internal logic.

Quick Start

Use the sdd-doc skill to save the current DM investigation as developer documentation in the repository.

Frequently Asked Questions about sdd-doc

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

FAQPage Schema
How do I generate developer documentation for Data Manager flows?

This Skill generates developer documentation for Data Manager flows by processing traced DM investigations and outputting Markdown files with Mermaid diagrams. It details service call chains, parameter mappings, and payload structures directly within your repository's docs directory.

What is the best way to document backend service chains and DM internals for onboarding?

Documenting backend service chains and DM internals is best handled by generating technical Markdown with Mermaid sequence diagrams. This approach provides new developers with clear visualizations of service logic and backend orchestrations for faster onboarding.

Can I save traced Data Manager flow documentation directly into my repository?

Yes, you can save traced Data Manager flow documentation directly into your repository. The Skill persists the generated technical Markdown files and Mermaid diagrams into the project's dedicated docs directory to maintain technical wiki content.

Does the generated Data Manager documentation include visual diagrams?

Yes, the generated Data Manager documentation includes visual diagrams. It leverages the sdd-design-doc-mermaid component to create technical sequence and class diagrams that map out complex backend service interactions and DM internals.

How do I deploy an interactive viewer for repository developer docs?

To deploy an interactive viewer for repository developer docs, the Skill utilizes the sdd-docs-viewer component after generating your Markdown documentation. This deploys an interactive HTML viewer to help teams understand Data Manager flows and technical service logic.

When do I need to document parameter mappings and payload structures in Markdown?

You need to document parameter mappings and payload structures in Markdown when maintaining a technical wiki or onboarding developers to complex backend orchestrations. This ensures technical service logic and Data Manager internals are easily understood.