documentation

Name: documentation
Availability: InStock
Author: itential

Group global Itential assets into use cases and generate markdown documentation.

13|12|Updated Mar 25, 2026

Search Tags:#documentation #markdown #catalog #relationships #use-cases #itential #platform-assets

Ready to run

npx skills add https://github.com/itential/builder-skills --skill documentation-itential

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/itential/builder-skills/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/itential/builder-skills --skill documentation-itential

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps teams catalog Itential platform assets that exist outside named projects, building a coherent view of global workflows, templates, forms, automations, and configurations, and grouping them into logical use cases for documentation.

Core Features & Use Cases

Survey global assets (workflows, templates, JSON forms, OM automations, Golden Config trees, LCM models) that live outside named projects.
Group assets into use cases and generate per-use-case customer-spec.md and solution-design.md, plus a master README when there are multiple use cases.
NOT for documenting a specific named project — use /project-to-spec for that scenario and to scope artifacts accordingly.

Quick Start

Document the platform by scanning all global assets and generating per-use-case customer-spec.md, solution-design.md, and a master README.

Frequently Asked Questions about documentation

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

FAQPage Schema

How do I document global Itential platform assets outside of named projects?▼

Documenting global Itential platform assets involves scanning workflows, templates, JSON forms, and automations outside named projects to group them into logical use cases and generate markdown documentation artifacts.

What is the best way to catalog platform-wide workflows and configurations into use cases?▼

Cataloging platform-wide workflows and configurations is best handled by surveying global assets, grouping them into logical use cases, and generating per-use-case customer-spec.md and solution-design.md files with a master README.

Can I generate solution design and customer spec markdown files for my global automations?▼

Generating solution design and customer spec markdown files for global automations is supported by grouping surveyed assets into logical use cases and producing per-use-case customer-spec.md and solution-design.md artifacts in-memory.

Does this documentation approach work for assets within a specific named project?▼

Documenting assets within a specific named project is not supported here; this skill targets global assets outside named projects. Use a project-to-spec approach to scope artifacts to a specific named project instead.

What markdown artifacts are generated when grouping assets into multiple use cases?▼

When grouping assets into multiple use cases, the generated markdown artifacts include per-use-case customer-spec.md and solution-design.md files, plus a master README to organize the overall documentation structure.

Do I need an intermediate JSON catalog to generate use-case documentation?▼

An intermediate JSON catalog is not needed to generate use-case documentation; the output is strictly markdown artifacts produced in-memory from the surveyed global platform assets.