create-justification

Create justification files with unique IDs and frontmatter under .agents/justifications/.

14.3k|3.0k|Updated Mar 12, 2023
One-click install
npx skills add https://github.com/documenso/documenso --skill create-justification
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-justification
Source: https://github.com/documenso/documenso/tree/main/.agents/skills/create-justification
Command: npx skills add https://github.com/documenso/documenso --skill create-justification

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams document the reasoning behind decisions by generating consistent justification files in the .agents/justifications/ directory. Each generated file uses a unique three-word identifier, frontmatter including the current date and a formatted title, and the user-provided content.

Core Features & Use Cases

  • Create a uniquely identified justification file with frontmatter for traceability (date and title).
  • Enforce a consistent filename format: {three-word-id}-{slug}.md, making it easy to search and audit decisions.
  • Use cases include recording architectural choices, product decisions, or design trade-offs with clear provenance.

Quick Start

Run the script with a slug and content to create a new justification entry in the repository.

Frequently Asked Questions about create-justification

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

FAQPage Schema
How do I document architectural decisions with consistent markdown formatting?

To document architectural decisions with consistent markdown formatting, this skill generates files under .agents/justifications/ with frontmatter including the date and a formatted title. It enforces a unique three-word ID and a slug-based filename for easy indexing.

What is the best way to automate creating justification files for project rationales?

The best way to automate creating justification files is providing a slug and content to this skill. It automatically generates a unique three-word identifier and frontmatter, saving the rationale as a structured markdown file for immediate traceability.

How does the unique ID generation work for decision-making documentation?

Unique ID generation for decision-making documentation works by creating a three-word identifier combined with your provided slug. This creates a consistent {three-word-id}-{slug}.md filename format that makes architectural choices easy to search and audit.

Can I use this to record design trade-offs without configuring dependencies?

Yes, you can record design trade-offs without configuring dependencies. The skill has no external dependencies and directly creates the markdown files with the required frontmatter and content in your repository.

What file format and frontmatter conventions are enforced for recording product decisions?

Markdown file format and frontmatter conventions are strictly enforced for recording product decisions. Each file includes the current date and a formatted title in the frontmatter to ensure clear provenance and consistent structure across projects.