Skills
.Work. You
Rest

trd-writing

Community

Define clear technical contracts for complex system designs.

Software Engineering#system design#technical documentation#failure modes#api contract#data schema
AuthorHigorAlves
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps engineers precisely document interfaces, data schemas, and failure modes, reducing ambiguities in system development.

Core Features & Use Cases

  • Technical Contract Specification: Enables detailed recording of APIs, data models, and error handling plans.
  • Documentation Standardization: Provides a structured template to ensure consistency across multiple teams and projects.
  • Use Case: When designing a new microservice, generate a TRD to specify data schemas and failure responses, facilitating aligned implementation.

Quick Start

Ask the AI to draft a TRD for a new payment API, including interfaces, data models, and failure conditions.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: trd-writing
Download link: https://github.com/HigorAlves/orc/archive/main.zip#trd-writing

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.