Get the FREE Ultimate OpenClaw Setup Guide →

structured-output

Scanned
output-patterns
npx machina-cli add skill athola/claude-night-market/structured-output --openclaw
Files (1)
SKILL.md
5.2 KB

Table of Contents

Structured Output

When To Use

  • When finalizing any review or analysis.
  • To format findings in a consistent and actionable way.
  • Before presenting results to stakeholders or committing them to documentation.

When NOT To Use

  • Capturing evidence during analysis - use evidence-logging
  • Reviewing changes - use diff-analysis or review-core first

Activation Patterns

Trigger Keywords: format, structure, deliverable, report, organize, present, consistent Contextual Cues:

  • "format this as a report" or "structure the output"
  • "create a deliverable" or "present these findings"
  • "organize this consistently" or "standardize the format"
  • "make this actionable" or "prepare for stakeholders"

Auto-Load When: Finalizing any analysis deliverable or when consistent formatting is requested.

Required TodoWrite Items

  1. structured-output:template-selected
  2. structured-output:findings-formatted
  3. structured-output:actions-assigned
  4. structured-output:appendix-attached

Mark each item complete as you finish the corresponding step.

Step 1: Select Template (structured-output:template-selected)

  • Choose output format based on deliverable type:
    • Review Report: Summary, Findings, Recommendations, Evidence.
    • PR Description: Summary, Changes, Test Plan, Notes.
    • Release Notes: Highlights, Breaking Changes, Fixes, Credits.
    • Incident Report: Timeline, Impact, Root Cause, Remediation.
  • Confirm audience and required detail level.

Step 2: Format Findings (structured-output:findings-formatted)

  • Use consistent finding structure: 
    ### [SEVERITY] Finding Title
**Location**: file.rs:123
**Category**: Security | Performance | Correctness | Style
**Description**: Brief explanation of the issue.
**Evidence**: [E1, E2] - Reference to evidence log.
**Recommendation**: Specific remediation steps.
    Verification: Run the command with --help flag to verify availability.
  • Severity levels: CRITICAL, HIGH, MEDIUM, LOW, INFO.
  • Order findings by severity, then by file location.

Step 3: Assign Actions (structured-output:actions-assigned)

  • Convert findings to actionable items: 
    ## Action Items
- [ ] [HIGH] Fix SQL injection in auth.py:45 (@security-team, P1)
- [ ] [MEDIUM] Add input validation to API endpoint (@backend, P2)
- [ ] [LOW] Update deprecated dependency (@devops, P3)
    Verification: Run the command with --help flag to verify availability.
  • Include owner assignment where known.
  • Add priority indicators (P1/P2/P3) for triage.
  • Note dependencies between actions.

Step 4: Attach Appendix (structured-output:appendix-attached)

  • Compile supporting materials: 
    ## Appendix
### A. Commands Run
[Full evidence log from imbue:evidence-logging]

### B. External References
[Citations and documentation links]

### C. Raw Data
[Large outputs, full diffs, or data exports]
    Verification: Run the command with --help flag to verify availability.
  • Keep main report concise; details in appendix.
  • validate appendix is navigable with clear section headers.

Output Quality Checklist

Before finalizing:

  • All findings have evidence references.
  • Severity levels are justified.
  • Recommendations are specific and actionable.
  • No orphaned sections or placeholder text.
  • Format renders correctly in target medium (GitHub, Confluence, etc.).

Exit Criteria

  • Todos completed with formatted deliverable.
  • Output follows selected template structure.
  • Stakeholders can act on findings without clarification.

Troubleshooting

Common Issues

Command not found Ensure all dependencies are installed and in PATH

Permission errors Check file permissions and run with appropriate privileges

Unexpected behavior Enable verbose logging with --verbose flag

Source

git clone https://github.com/athola/claude-night-market/blob/master/plugins/imbue/skills/structured-output/SKILL.mdView on GitHub

Overview

Structured-output standardizes how final review deliverables are formatted, ensuring a consistent structure and making findings comparable across reviews. It relies on predefined templates, a standardized finding format, and clear action items to support stakeholder-ready documentation.

How This Skill Works

During finalization, select the appropriate template (Review Report, PR Description, Release Notes, or Incident Report), format each finding using a consistent header with Severity, Location, Category, Description, Evidence, and Recommendation, and convert findings into actionable items before optionally attaching an appendix. The workflow uses the signals template-selected, findings-formatted, actions-assigned, and appendix-attached to track progress.

When to Use It

  • When finalizing any review or analysis to produce a ready-to-share deliverable.
  • When formatting findings to be consistent and actionable for cross-review comparability.
  • When presenting results to stakeholders or including them in documentation.
  • When generating deliverables using explicit templates (Review Report, PR Description, Release Notes, Incident Report).
  • When you need a repeatable, auditable formatting process across projects.

Quick Start

  1. Step 1: Choose output template based on deliverable type (Review Report, PR Description, Release Notes, Incident Report).
  2. Step 2: Format Findings using the standardized header and fields (Severity, Location, Category, Description, Evidence, Recommendation).
  3. Step 3: Convert findings to Action Items and attach Appendix if needed; update TodoWrite items accordingly.

Best Practices

  • Always choose the correct template for the deliverable type (Review Report, PR Description, Release Notes, Incident Report).
  • Format findings with the exact structure: Severity, Location, Category, Description, Evidence, Recommendation.
  • Order findings by severity first, then by file location for readability.
  • Convert findings into Action Items with clear owners and priorities; mark ownership when known.
  • Use the Output Quality Checklist and update the Required TodoWrite Items as you progress.

Example Use Cases

  • Review Report: internal security audit with Findings, Recommendations, and Evidence using a consistent structure.
  • PR Description: Summary, Changes, Test Plan, and Notes documented with the structured-output format.
  • Release Notes: Highlights, Breaking Changes, Fixes, Credits for version 2.3.
  • Incident Report: Timeline, Impact, Root Cause, Remediation written in a standardized deliverable.
  • Audit Deliverable: Vendor compliance review with standardized sections and actionable items.

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers ↗