ring-tw-team
NewTechnical writing specialists for functional and API documentation. 3 specialized agents (functional-writer, api-writer, docs-reviewer) and 4 documentation skills covering voice/tone, structure, API field descriptions, and quality review. Enforces clear, consistent documentation standards.
Overview
<p align="center"> <img src="assets/ring-banner.png" alt="Ring by Lerian" width="100%" /> </p>
๐ The Ring - Skills Library for AI Agents
Proven engineering practices, enforced through skills.
Ring is a comprehensive skills library and workflow system for AI agents that transforms how AI assistants approach software development. Currently implemented as a Claude Code plugin marketplace with 4 active plugins, 71 skills, and 33 agents (see .claude-plugin/marketplace.json for current versions), the skills themselves are agent-agnostic and can be used with any AI agent system. Ring provides battle-tested patterns, mandatory workflows, and systematic approaches across the entire software delivery value chain.
โจ Why Ring?
Without Ring, AI assistants often:
- โขSkip tests and jump straight to implementation
- โขMake changes without understanding root causes
- โขClaim tasks are complete without verification
- โขForget to check for existing solutions
- โขRepeat known mistakes
Ring solves this by:
- โขEnforcing proven workflows - Test-driven development, systematic debugging, proper planning
- โขProviding 71 specialized skills (16 core + 33 dev-team + 18 product planning + 4 technical writing)
- โข33 specialized agents - 2 planning/analysis + 24 developer/reviewer + 4 product research + 3 technical writing
- โขAutomating skill discovery - Skills load automatically at session start
- โขPreventing common failures - Built-in anti-patterns and mandatory checklists
๐งญ Project Identity
Ring is Lerian-first, open-source-friendly. Design decisions prioritize the Lerian engineering team's daily needs while keeping the architecture clean and reusable for external adoption. This means:
- โขLerian-specific skills stay active โ Internal integrations and domain-specific workflows remain in the marketplace because the team uses them
- โขThe architecture is universal โ Skills, agents, and the plugin system work with any codebase or team
- โขArchival is usage-driven โ Skills are archived when they stop being used, not because they're "too specific"
๐ค Specialized Agents
Planning & Analysis Agents (default plugin):
- โข
ring:review-slicer- Review slicer (groups large multi-themed PRs into thematic slices for focused parallel review) - โข
ring:codebase-explorer- Deep architecture analysis (deep-analysis, complements built-in Explore) - โขUse
ring:reviewing-codeskill to orchestrate parallel review workflow
Developer Agents (dev-team plugin):
- โข
ring:backend-go- Go backend specialist for financial systems - โข
ring:backend-ts- TypeScript/Node.js backend specialist (Express, NestJS, Fastify) - โข
ring:bff-ts- BFF & React/Next.js frontend with Clean Architecture - โข
ring:ui-designer- Visual design specialist - โข
ring:frontend- Senior Frontend Engineer (React/Next.js) - โข
ring:devops- DevOps and infrastructure specialist - โข
ring:prompt-reviewer- Agent Quality Analyst - โข
ring:qa- Backend QA specialist (unit, integration, load, chaos) - โข
ring:qa-frontend- Frontend QA specialist (accessibility, visual, E2E, performance) - โข
ring:sre- Observability and reliability specialist - โข
ring:ui-engineer- UI component specialist (design systems, accessibility) - โข
ring:helm- Helm chart specialist (chart structure, security, Lerian conventions) - โข
ring:code-reviewer- Foundation review (architecture, code quality, design patterns) - โข
ring:logic-reviewer- Correctness review (domain logic, requirements, edge cases) - โข
ring:security-reviewer- Safety review (vulnerabilities, OWASP, authentication) - โข
ring:test-reviewer- Test quality review (coverage, edge cases, assertions, test anti-patterns) - โข
ring:nil-reviewer- Nil/null safety review (traces pointer risks, missing guards, panic paths) - โข
ring:dead-code-reviewer- Dead code review (orphaned code detection, reachability analysis, dead dependency chains) - โข
ring:commons-reviewer- lib-commons package usage review (lifecycle, tenancy, http, idempotency, security, database, messaging, outbox; reinvented-wheel opportunities) - โข
ring:obs-reviewer- Conditional specialist for tracing, metrics, logging, runtime recovery, redaction, constants, and SafeGo implications - โข
ring:systemplane-reviewer- Conditional specialist for runtime config, hot-reload knobs, admin config, tenant-scoped settings, and systemplane imports - โข
ring:streaming-reviewer- Conditional specialist for business events, outbox, producers, broker publishing, CloudEvents, manifests, and catalogs - โข
ring:tenancy-reviewer- Multi-tenant usage review (lib-commons/multitenancy patterns, tenant isolation, JWT tenantId propagation) - โข
ring:perf-reviewer- Performance review (code hotspots, infra misconfigurations, Go/TypeScript/Python)
Standards Compliance: Refactor-capable dev-team agents produce a
## Standards Complianceoutput section with conditional requirement:- Optional when invoked directly or via
ring:running-dev-cycle- MANDATORY when invoked from
ring:planning-backend-refactor(triggered by**MODE: ANALYSIS ONLY**in prompt)When mandatory, agents load Ring standards via WebFetch and produce comparison tables with:
- Current Pattern vs Expected Pattern
- Severity classification (Critical/High/Medium/Low)
- File locations and migration recommendations
See
dev-team/docs/standards/*.mdfor standards source. Cross-references: CLAUDE.md (Standards Compliance section),dev-team/skills/planning-backend-refactor/SKILL.md
Product Research Agents (ring-pm-team plugin):
- โข
ring:repo-researcher- Repository structure and codebase analysis - โข
ring:web-researcher- Industry best practices research - โข
ring:docs-researcher- Framework documentation research - โข
ring:product-designer- Product design and UX research
Technical Writing Agents (ring-tw-team plugin):
- โข
ring:guide-writer- Functional documentation (guides, tutorials, conceptual docs) - โข
ring:api-writer- API reference documentation (endpoints, schemas, examples) - โข
ring:docs-reviewer- Documentation quality review (voice, tone, structure, completeness)
_Plugin versions are managed in .claude-plugin/marketplace.json_
๐ฆ Archived Plugins
The following plugins have been archived and are not actively maintained. They remain available in .archive/ for reference:
| Plugin | Description | Status |
|---|---|---|
pmm-team | Product Marketing (GTM, positioning, competitive intel) | Archived - functionality may be restored based on demand |
finance-team | Financial planning and analysis | Archived - under evaluation |
ops-team | Operations management | Archived - under evaluation |
_To restore an archived plugin, move its folder from .archive/ to the root directory and register it in marketplace.json._
๐ฅ๏ธ Supported Platforms
Ring works across multiple AI development platforms:
| Platform | Native manifest | Symlink installer | Status |
|---|---|---|---|
| Claude Code | โ marketplace.json | โ
--claude | Source of truth |
| Codex | โ
.codex-plugin/ | โ
--codex (built) | Both paths work |
| OpenCode | โ
.opencode/ | โ
--opencode (built) | Both paths work |
| Cursor | โ
.cursor-plugin/ | โ not in installer | Native only |
| Factory AI | โ | โ
--factory | Installer only |
Two install mechanisms:
- โขNative manifest โ the harness installs Ring directly from this repo via its own package manager (
opencode.json, Cursor plugin marketplace, Codex plugin manifest). No local build step, no manual symlink work. Best for end users and CI. - โขSymlink installer (
ring-install.sh) โ symlinks from your local harness config dir into a cloned Ring repo. For Codex/OpenCode, the installer builds a transformed tree at.ring-build/first (namespace + frontmatter rewrites). Best for local development with hot-reload against the source tree.
See the `Native plugin install` and `Symlink installer` sub-sections below for usage.
๐ Quick Start
Native plugin install (per harness)
Each Ring plugin ships native manifests for Claude Code, Codex, Cursor, and OpenCode. The harness installs the plugin directly from this repo via its own package manager โ no transformation step, no local installer.
| Harness | Mechanism | Per-plugin entry points |
|---|---|---|
| Claude Code | .claude-plugin/marketplace.json (root) | All 4 plugins enumerated in one marketplace file |
| Codex | <plugin>/.codex-plugin/plugin.json | default ยท dev-team ยท pm-team ยท tw-team |
| Cursor | <plugin>/.cursor-plugin/plugin.json | default ยท dev-team ยท pm-team ยท tw-team |
| OpenCode | <plugin>/.opencode/ (INSTALL + JS plugin) | default ยท dev-team ยท pm-team ยท tw-team |
`ring-default` is the foundation plugin โ install it alongside any other Ring plugin since it provides the using-ring bootstrap that orients agent behavior. Example for OpenCode:
{
"plugin": [
"ring-default@git+https://github.com/lerianstudio/ring.git#main",
"ring-dev-team@git+https://github.com/lerianstudio/ring.git#main"
]
}Each harness's INSTALL.md (for OpenCode) or plugin.json (for Codex/Cursor) carries the exact install command for that platform.
Symlink installer (local dev)
ring-install.sh symlinks your harness's local config dir into this cloned Ring repo. For Codex and OpenCode, it first builds a transformed tree at .ring-build/ (namespace + frontmatter rewrites required by those tools).
Supported targets: Claude Code, Factory AI, OpenCode, Codex. Not supported by the installer: Cursor (use the native plugin install above).
# Clone the repo
git clone https://github.com/lerianstudio/ring.git ~/ring
cd ~/ring
# Interactive menu (lets you pick targets)
bash ring-install.sh
# Or target specific harnesses without the prompt:
bash ring-install.sh --claude # Claude Code (per-file symlinks)
bash ring-install.sh --factory # Factory AI (per-file symlinks)
bash ring-install.sh --opencode # OpenCode (builds .ring-build/opencode/ first)
bash ring-install.sh --codex # Codex (builds .ring-build/codex/ first)
bash ring-install.sh --all # All four supported targetsbash ring-install.sh install --opencode --codex # install symlinks for selected targets
bash ring-install.sh remove # remove all Ring symlinks
bash ring-install.sh build # rebuild .ring-build/{opencode,codex} only
bash ring-install.sh clean # remove .ring-build/ outputs
bash ring-install.sh doctor # verify install + build outputs
bash ring-install.sh all --all -y # clean + build + install for all targets, no promptFlags: --yes / -y (skip confirmation), --dry-run (preview without changes), --force (back up non-symlink collisions), --verbose.
Claude Code Plugin Marketplace
For Claude Code users, you can also install from the marketplace:
- โขOpen Claude Code
- โขGo to Settings โ Plugins
- โขSearch for "ring"
- โขClick Install
Manual Installation (Claude Code only)
# Clone the marketplace repository
git clone https://github.com/lerianstudio/ring.git ~/ring
# Skills auto-load at session start via hooks
# No additional configuration needed for Claude CodeCode Analysis Pipeline
The ring:reviewing-code pipeline uses Mithril, an external code analysis tool installed via go install. Mithril performs static analysis, AST extraction, call graph generation, and context compilation for AI-assisted code review.
Install via go install github.com/lerianstudio/mithril@latest. See the Mithril repository for full installation details and release notes.
First Session
When you start a new Claude Code session with Ring installed, you'll see:
## Available Skills:
- ring:using-ring (Check for skills BEFORE any task)
- ring:test-driven-development (RED-GREEN-REFACTOR cycle)
- ring:reviewing-code (9 defaults + conditional specialist dispatch)
- ring:exploring-codebases (Two-phase codebase exploration)
... and 73 more skills๐ฏ Core Skills
Start Here
Before ANY action โ Check skills
Before ANY tool โ Check skills
Before ANY code โ Check skillsRED โ Write failing test โ Watch it fail
GREEN โ Minimal code โ Watch it pass
REFACTOR โ Clean up โ Stay green๐ All 71 Skills (Across 4 Plugins)
Core Skills (ring-default plugin - 16 skills)
Testing & Quality (2):
- โข
ring:test-driven-development- Write test first, watch fail, minimal code - โข
ring:fixing-lint- Parallel lint fixing with agent dispatch
Collaboration & Planning (5):
- โข
ring:reviewing-code- Parallel 9 defaults + conditional specialist dispatch with severity-based handling - โข
ring:creating-worktrees- Isolated development - โข
ring:committing-changes- Smart commit organization with atomic grouping, conventional commits, and trailers - โข
ring:writing-plans- Author phased implementation plans (phase โ epic โ task) from a spec; first phase detailed into dispatch-ready tasks, later phases epic-level for rolling-wave elaboration - โข
ring:executing-plans- Rolling-wave execution of a phased plan: implement the detailed phase, checkpoint with the user, elaborate the next phase against the real codebase, repeat
Meta Skills (3):
- โข
ring:using-ring- Mandatory skill discovery - โข
ring:writing-skills- TDD for documentation - โข
ring:testing-skills-with-subagents- Skill validation
Integration (1):
- โข
ring:delegating-to-gandalf- Send tasks to Gandalf (AI team member) via webhook for Slack, Google Workspace, and Jira interactions
Session & Learning (4):
- โข
ring:exploring-codebases- Two-phase codebase exploration - โข
ring:generating-release-guides- Generate Ops Update Guide from git diff analysis - โข
ring:visualizing- Generate self-contained HTML pages to visually explain systems, code changes, and data - โข
ring:creating-handoffs- Create handoff documents capturing session state for seamless context-clear and resume
Audit & Readiness (1):
- โข
ring:auditing-production-readiness- 44-dimension production readiness audit; runs explorers in batches of up to 10, appends incrementally to a single report; output: scored report (0-430, max 440 with multi-tenant) with severity ratings. See default/skills/auditing-production-readiness/SKILL.md for invocation and implementation details.
Developer Skills (ring-dev-team plugin - 33 skills)
Orchestration & Refactoring (7):
- โข
ring:using-dev-team- Introduction to developer specialist agents - โข
ring:running-dev-cycle- Lean backend development cycle orchestrator driven by a rolling-wave phased plan (phases โ epics E-X.Y โ tasks T-X.Y.Z): Gate 0 implementation-owned TDD/coverage/docker-compose/runtime/delivery verification per task, Gate 8 review + Gate 9 validation per epic, phase boundary (Step 11.5) closes each phase and elaborates the next against the real codebase - โข
ring:running-dev-cycle-frontend- Lean frontend development cycle orchestrator on the same rolling-wave phased plan (Gate 0 per task, Gate 7 review per epic, Gate 8 validation per task, phase boundary per phase) - โข
ring:planning-backend-refactor- Backend/codebase standards analysis - โข
ring:planning-frontend-refactor- Frontend standards analysis and task generation - โข
ring:planning-codebase-simplification- Whole-codebase structural simplification sweep (hunts unjustified abstractions, adapters, shims; KILL/REVIEW/KEEP output; DELETE-by-default burden of proof for pre-public applications) - โข
ring:managing-dev-cycle- Development cycle state management (phase/epic status reporting and cancellation)
Backend Gate Skills:
- โข
ring:implementing-tasks- Gate 0: TDD implementation - โข
ring:adding-multi-tenancy- Multi-tenant adaptation (database-per-tenant isolation, integrated into Gate 0) - โข
ring:hardening-dockerfiles- Docker image security audit for Docker Hub Health Score grade A - โข
ring:creating-helm-charts- Helm chart creation and maintenance following Lerian conventions - โข
ring:mapping-service-resources- Service/module/resource hierarchy scanner for dispatch layer - โข
ring:implementing-readyz- Comprehensive readiness probes (/readyz) with per-dependency status and TLS validation - โข
ring:instrumenting-streaming-events- Wire lib-streaming event emission from a validated instrumentation map
Testing & Validation:
- โข
ring:detecting-goroutine-leaks- Goroutine leak detection and regression testing - โข
ring:load-testing-with-k6- k6 load test generation following Lerian platform conventions - โข
ring:validating-acceptance-criteria- Gate 9: User approval - โข
ring:writing-dev-reports- Assertiveness scoring and metrics - โข
ring:verifying-code- Atomic Go code verification with MERGE_READY/NEEDS_FIX verdict
Migration & Reference (6):
- โข
ring:using-lib-commons- Comprehensive reference for lib-commons v5.0.2 (Lerian's shared Go library with 30+ packages) - โข
ring:using-runtime- Deep reference and 6-angle audit for lib-observability/runtime: SafeGo, panic recovery, observability trident, policy selection, framework integration. Catches naked goroutine launches that cause silent production failures. - โข
ring:using-assert- Deep reference and 6-angle audit for lib-observability/assert: production runtime assertions with observability trident, full domain predicate catalog (double-entry, transaction state machine, financial validations), AssertionError unwrapping patterns. Converts financial invariants into production-enforced rules. - โข
ring:migrating-to-lib-systemplane- Migrate Lerian Go services from .env/YAML config to systemplane (database-backed hot-reloadable config) - โข
ring:generating-llms-txt- Generate or audit llms.txt files following llmstxt.org spec for AI-friendly repository entry points - โข
ring:applying-licenses- Repository license management (Apache 2.0, Elastic v2, Proprietary)
Security (1):
- โข
ring:auditing-dependency-security- Supply-chain gate for dependency installations (validates identity, vulnerabilities, suspicious signals)
Frontend Quality Skills (1):
- โข
ring:checking-frontend-quality- Frontend quality checks in modesaccessibility(axe-core/WCAG),visual(snapshots/viewports),e2e(Playwright 3-browser),performance(Lighthouse/Core Web Vitals), orall; dispatchesring:qa-frontend
Frontend and backend dev-cycle workflows both use
ring:reviewing-code(core plugin) as the review gate.
Product Planning Skills (ring-pm-team plugin - 18 skills)
Pre-Development Workflow (includes ring:using-pm-team + 9 gates):
- โข
ring:using-pm-team- Introduction to product planning workflow
ring:researching-features- Research phase (parallel agents)ring:writing-prds- Business requirements (WHAT/WHY)ring:mapping-feature-relationships- Feature relationshipsring:writing-trds- Technical architecture (HOW)ring:designing-api-contracts- Component contractsring:designing-data-model- Entity relationshipsring:pinning-dependency-versions- Technology selectionring:decomposing-phases-and-epics- Phased plan: phases + epics, rolling wavering:detailing-tasks- Phase 1 task detailing: dispatch-ready tasks, no code
Workflow Orchestrators:
- โข
ring:planning-small-features- 5-gate orchestrator for small features (<2 days) - โข
ring:planning-large-features- 10-gate orchestrator for large features (>=2 days)
Additional Planning Skills:
- โข
ring:validating-ux-completeness- Gate 1.5/2.5: Design validation for UI features - โข
ring:planning-delivery- Gate 4 (Small) / Gate 9 (Large): Delivery roadmap and timeline - โข
ring:tracking-delivery- Delivery progress tracking against roadmap - โข
ring:reconciling-predev-docs- Deep cross-reference review of pre-dev documentation artifacts
Technical Writing Skills (ring-tw-team plugin - 4 skills)
Documentation Creation:
- โข
ring:using-tw-team- Introduction to technical writing specialists - โข
ring:structuring-documentation- Document hierarchy and organization - โข
ring:applying-voice-and-tone- Voice and tone guidelines (assertive, encouraging, human) - โข
ring:reviewing-docs- Quality checklist and review process
๐ก Usage Examples
Building a Feature
User: "Add user authentication to the app"
Claude: I'm using ring:planning-small-features to scope this feature...
[Pre-dev workflow: PRD, TRD, tasks]
Claude: I'm using ring:test-driven-development to implement...
[RED-GREEN-REFACTOR cycle for each component]
Claude: I'm using ring:reviewing-code to validate...
[9 defaults + conditional specialist parallel dispatch]Fixing a Bug
User: "The app crashes when clicking submit"
Claude: Investigating the crash:
Phase 1: [Gathering evidence]
Phase 2: [Pattern analysis]
Phase 3: [Hypothesis testing]
Phase 4: [Implementing fix with test]Planning a Project
User: "Plan an e-commerce platform"
Claude: I'll use the pre-dev workflow to plan this systematically...
Gate 1: PRD Creation [Business requirements]
Gate 2: Feature Map [Domain groupings]
Gate 3: TRD Creation [Architecture patterns]
... [Through all 10 gates]Code Review (Parallel, 9 Defaults + Conditional Specialists)
User: "Review my authentication implementation"
Claude: Dispatching all 9 default reviewers plus triggered conditional specialists in parallel...
[Launches ring:code-reviewer, ring:logic-reviewer, ring:security-reviewer,
ring:test-reviewer, ring:nil-reviewer,
ring:dead-code-reviewer, ring:perf-reviewer, ring:tenancy-reviewer,
ring:commons-reviewer simultaneously]
Conditional specialists trigger only when the diff touches their stack:
lib-observability, lib-systemplane, or lib-streaming.
Code reviewer: PASS. Clean architecture, good tests.
Business reviewer: FAIL. Missing password reset flow (HIGH severity).
Security reviewer: FAIL. JWT secret hardcoded (CRITICAL severity).
Test reviewer: PASS. Good coverage, assertions well-structured.
Nil-safety reviewer: PASS. No unguarded nil dereferences found.
Performance reviewer: PASS. No hotspots or goroutine leaks found.
Multi-tenant reviewer: PASS. No multi-tenant code in scope.
lib-commons reviewer: PASS. Correct shared-library usage, no reinvented wheels detected.
Aggregating issues by severity:
- CRITICAL: JWT secret hardcoded in auth.ts:42
- HIGH: Password reset flow missing from requirements
Review report complete. No files changed by reviewers.
Fixes require a separate implementation step, then a new review run.Key benefits:
- โขAll reviewers run simultaneously (not sequential)
- โขComprehensive - Get all feedback at once, easier to prioritize
- โขReport-only boundary - Reviewers report findings; remediation is a separate step
- โขSpecialized lanes - Each reviewer owns a clear domain to avoid duplicate slop
๐๏ธ Architecture
Monorepo Marketplace - Multiple specialized plugin collections:
ring/ # Monorepo root
โโโ .claude-plugin/
โ โโโ marketplace.json # Multi-plugin marketplace config (4 active plugins)
โโโ default/ # Core Ring plugin (ring-default)
โ โโโ skills/ # 16 core skills
โ โ โโโ skill-name/
โ โ โ โโโ SKILL.md # Skill definition with frontmatter
โ โ โโโ shared-patterns/ # Universal patterns (15 patterns)
โ โโโ hooks/ # Session initialization
โ โ โโโ hooks.json # Hook configuration
โ โ โโโ session-start.sh # Loads skills at startup
โ โ โโโ generate-skills-ref.py # Auto-generates quick reference
โ โโโ agents/ # 2 planning/analysis agents
โ โ โโโ review-slicer.md # Review slicing for large PRs (`ring:review-slicer`)
โ โ โโโ codebase-explorer.md # Deep architecture analysis (`ring:codebase-explorer`)
โ โโโ docs/ # Documentation
โโโ dev-team/ # Developer Agents plugin (ring-dev-team) - 33 skills, 24 agents
โ โโโ agents/ # 24 specialized developer/reviewer agents
โ โโโ backend-go.md # Go backend specialist (`ring:backend-go`)
โ โโโ backend-ts.md # TypeScript/Node.js backend specialist (`ring:backend-ts`)
โ โโโ bff-ts.md # BFF & React/Next.js specialist (`ring:bff-ts`)
โ โโโ devops.md # DevOps and infrastructure specialist (`ring:devops`)
โ โโโ ui-designer.md # Visual design specialist (`ring:ui-designer`)
โ โโโ frontend.md # Frontend engineer (`ring:frontend`)
โ โโโ helm.md # Helm chart specialist (`ring:helm`)
โ โโโ code-reviewer.md # Foundation review (`ring:code-reviewer`)
โ โโโ logic-reviewer.md # Correctness review (`ring:logic-reviewer`)
โ โโโ security-reviewer.md # Safety review (`ring:security-reviewer`)
โ โโโ test-reviewer.md # Test quality review (`ring:test-reviewer`)
โ โโโ nil-reviewer.md # Nil/null safety review (`ring:nil-reviewer`)
โ โโโ dead-code-reviewer.md # Dead code analysis (`ring:dead-code-reviewer`)
โ โโโ commons-reviewer.md # lib-commons usage review (`ring:commons-reviewer`)
โ โโโ obs-reviewer.md # Conditional observability review (`ring:obs-reviewer`)
โ โโโ systemplane-reviewer.md # Conditional runtime-config review (`ring:systemplane-reviewer`)
โ โโโ streaming-reviewer.md # Conditional event producer review (`ring:streaming-reviewer`)
โ โโโ tenancy-reviewer.md # Multi-tenant usage review (`ring:tenancy-reviewer`)
โ โโโ perf-reviewer.md # Performance review (`ring:perf-reviewer`)
โ โโโ prompt-reviewer.md # Agent quality reviewer (`ring:prompt-reviewer`)
โ โโโ qa.md # Backend QA specialist (`ring:qa`)
โ โโโ qa-frontend.md # Frontend QA specialist (`ring:qa-frontend`)
โ โโโ sre.md # Observability and reliability specialist (`ring:sre`)
โ โโโ ui-engineer.md # UI component specialist (`ring:ui-engineer`)
โโโ pm-team/ # Product Planning plugin (ring-pm-team)
โ โโโ skills/ # 18 product planning skills
โ โโโ writing-prds/ # PRD authoring
โ โโโ writing-trds/ # TRD authoring
โ โโโ designing-api-contracts/ # API contract design
โ โโโ designing-data-model/ # Data model design
โ โโโ detailing-tasks/ # Task detailing
โโโ tw-team/ # Technical Writing plugin (ring-tw-team)
โโโ skills/ # 4 documentation skills
โโโ agents/ # 3 technical writing agents
โโโ hooks/ # SessionStart hook๐ค Contributing
Adding a New Skill
For core Ring skills:
- Create the skill directory
``bash mkdir default/skills/your-skill-name ``
- Write SKILL.md with frontmatter
```yaml --- name: ring:your-skill-name description: Single paragraph (โค500 chars target, 1,536 cap). States WHAT the skill does, WHEN to invoke, and WHEN to skip. ---
# Your Skill Name
## When to use - Specific condition that mandates this skill - Another trigger condition
## Skip when - When NOT to use โ alternative skill - Another exclusion ```
Schema fields:
- Required: name (must use ring: prefix), description - Optional: argument-hint, allowed-tools, model, disable-model-invocation, user-invocable, paths - Trigger / skip / sequence / related content lives in body H2 sections (## When to use, ## Skip when, ## Sequence, ## Related). See docs/FRONTMATTER_SCHEMA.md for the canonical schema.
- Update documentation
- Skills auto-load via default/hooks/generate-skills-ref.py - Test with session start hook
- Submit PR
``bash git checkout -b feat/your-skill-name git add default/skills/your-skill-name git commit -m "feat(skills): add your-skill-name for X" gh pr create ``
For product/team-specific skills:
- Create plugin structure
``bash mkdir -p product-xyz/{skills,agents,hooks,lib} ``
- Register in marketplace
Edit .claude-plugin/marketplace.json:
``json { "name": "ring-product-xyz", "description": "Product XYZ specific skills", "version": "0.1.0", "source": "./product-xyz", "homepage": "https://github.com/lerianstudio/ring/tree/product-xyz" } ``
- Follow core plugin structure
- Use same layout as default/ - Create product-xyz/hooks/hooks.json for initialization - Add skills to product-xyz/skills/
Skill Quality Standards
- โขMandatory sections: When to use, How to use, Anti-patterns
- โขInclude checklists: TodoWrite-compatible task lists
- โขEvidence-based: Require verification before claims
- โขBattle-tested: Based on real-world experience
- โขClear triggers: Unambiguous "when to use" conditions
๐ Documentation
- โขSkills Quick Reference - Auto-generated at session start from skill frontmatter
- โขCLAUDE.md - Repository guide for Claude Code
- โขMANUAL.md - Quick reference for all skills, agents, and workflows
- โขARCHITECTURE.md - Architecture diagrams and component relationships
- โขInstaller - Multi-platform installation and migration
๐ฏ Philosophy
Ring embodies these principles:
- Skills are mandatory, not optional - If a skill applies, it MUST be used
- Evidence over assumptions - Prove it works, don't assume
- Process prevents problems - Following workflows prevents known failures
- Small steps, verified often - Incremental progress with continuous validation
- Learn from failure - Anti-patterns document what doesn't work
๐ Success Metrics
Teams using Ring report:
- โข90% reduction in "works on my machine" issues
- โข75% fewer bugs reaching production
- โข60% faster debugging cycles
- โข100% of code covered by tests (enforced by TDD)
๐ Acknowledgments
Ring is built on decades of collective software engineering wisdom, incorporating patterns from:
- โขExtreme Programming (XP)
- โขTest-Driven Development (TDD)
- โขDomain-Driven Design (DDD)
- โขAgile methodologies
- โขDevOps practices
Special thanks to the Lerian Team for battle-testing these skills in production.
๐ License
MIT - See LICENSE file
๐ Links
Remember: If a skill applies to your task, you MUST use it. This is not optional.
Install & Usage
mkdir -p .claude/skillsmkdir -p .claude/skills && curl -o .claude/skills/ring-tw-team.md https://raw.githubusercontent.com/lerianstudio/ring/main/tw-team/SKILL.md/ring-tw-teamFrequently Asked Questions
What is ring-tw-team?
Technical writing specialists for functional and API documentation. 3 specialized agents (functional-writer, api-writer, docs-reviewer) and 4 documentation skills covering voice/tone, structure, API field descriptions, and quality review. Enforces clear, consistent documentation standards.
How to install ring-tw-team?
To install ring-tw-team, create the .claude/skills directory in your project, then run the curl command to download the skill file. Once installed, invoke it in Claude Code with /ring-tw-team.
What is ring-tw-team best for?
ring-tw-team is a community categorized under General. It is designed for: code-review, documentation, api, agent, technical-writing, api-docs, guides, tutorials. Created by Presenter Name.