Verified:GitHub

trellis-update-spec

Capture implementation knowledge and debugging discoveries as executable project specifications.

132|26|Updated Sep 9, 2022

Search Tags:#debugging #validation #coding conventions #api contracts #developer documentation #code specifications #technical knowledge

Ready to run

npx skills add https://github.com/ROYIANS/print-template-designer --skill trellis-update-spec-royians

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: trellis-update-spec
Source: https://github.com/ROYIANS/print-template-designer/tree/main/.cursor/skills/trellis-update-spec
Command: npx skills add https://github.com/ROYIANS/print-template-designer --skill trellis-update-spec-royians

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents valuable implementation knowledge, debugging discoveries, and design decisions from being lost between sessions or repeated by future developers.

Core Features & Use Cases

Code-Spec Documentation: Capture concrete signatures, contracts, validation rules, error behavior, tests, and implementation conventions.
Structured Knowledge Updates: Classify discoveries as design decisions, project conventions, reusable patterns, forbidden patterns, common mistakes, or gotchas.
Cross-Layer Coverage: Document backend, frontend, database, API, infrastructure, and other changes requiring precise executable contracts.
Use Case: After implementing a new API integration, use this Skill to update the relevant specification with request and response fields, validation errors, test assertions, and wrong-versus-correct examples.

Quick Start

Ask the trellis-update-spec skill to capture the contracts, decisions, and lessons learned from the completed implementation in the appropriate project specification.

Frequently Asked Questions about trellis-update-spec

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

FAQPage Schema

How do I document API contracts and validation rules after fixing a bug?▼

You document API contracts and validation rules by capturing concrete signatures, error behavior, and test assertions as executable project specifications. This preserves debugging discoveries and implementation patterns so they are not lost between sessions or repeated by future developers.

What is the best way to preserve coding conventions and debugging discoveries across development sessions?▼

The best way to preserve coding conventions is to classify discoveries as design decisions, reusable patterns, or forbidden patterns within structured project specifications. This captures technical knowledge including common mistakes and gotchas for future reference.

Can I use this to document cross-layer specifications for database changes and frontend integrations?▼

Yes, you can document cross-layer specifications covering backend, frontend, database, API, and infrastructure changes. It requires structured documentation of signatures, validation, error behavior, representative cases, tests, and correct implementation patterns for each layer.

How do I update project specifications with request and response fields after implementing a new API integration?▼

You update project specifications by recording request and response fields, validation errors, test assertions, and wrong-versus-correct implementation examples. This ensures the API integration is documented as an executable contract with representative cases.

When do I need executable code specifications instead of standard developer documentation?▼

You need executable code specifications when you must capture precise contracts, design decisions, and infrastructure integrations that standard developer documentation cannot enforce. This approach prevents valuable implementation knowledge from being lost or repeated.