AgentSkillsCN

silvan-best-practices

为 Silvan CLI 与 UI UX 的一致性、输出规范、JSON 及冗余行为、错误恢复、新手引导，以及操作员工作流程提供指导。在实现或评审 CLI 输出、帮助流程或新手引导、错误处理、JSON Schema、运行生命周期 UX，或在此仓库中开发仪表盘功能时，可参考此指南。

SKILL.md
--- frontmatter
name: silvan-best-practices
description: Guidelines for Silvan CLI and UI UX consistency, output conventions, JSON and verbosity behavior, error recovery, onboarding, and operator workflows. Use when implementing or reviewing CLI output, help or onboarding flows, error handling, JSON schemas, run lifecycle UX, or dashboard features in this repo.

Silvan Best Practices

Overview

Use this skill to keep Silvan's UX consistent and operator-grade. It provides a shared checklist and references for CLI output, errors, JSON behavior, onboarding, and UI surfaces.

Quick workflow

  1. •Identify the UX surface (CLI output, JSON, errors, onboarding/help, UI).
  2. •Read references/best-practices.md for conventions and guardrails.
  3. •Reuse or extend shared utilities instead of adding one-off formatting.
  4. •Ensure success confirmations, next steps, and actionable errors.
  5. •Update tests and docs when behavior or output changes.

Definition of done

  • •Output uses semantic colors and consistent formatting.
  • •--json output is schema-stable and error-safe.
  • •Errors include recovery steps and docs links when relevant.
  • •Commands never exit silently on success.
  • •TTY and non-TTY output are both readable.

References

  • •references/best-practices.md: canonical UX and output standards.