platonic-specs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Platonic Coding Specs

Platonic 编码规范

Manage RFC-style specifications in development projects with AI-driven operations.
在开发项目中通过AI驱动的操作管理RFC风格的规范。

When to Use This Skill

何时使用此Skill

Use this skill when you need to:
  • Validate existing specifications for consistency and standard compliance
  • Generate or update history, index, and terminology files
  • Check taxonomy and cross-reference consistency
  • Refine specifications following best practices
Note: For project initialization (creating specs directories and templates), use platonic-init.
Keywords: RFC, specifications, documentation, validation, taxonomy, terminology
当你需要以下操作时使用本Skill:
  • 验证现有规范的一致性和标准合规性
  • 生成或更新历史记录、索引和术语文件
  • 检查分类法和交叉引用的一致性
  • 遵循最佳实践优化规范
注意:如需项目初始化(创建规范目录和模板),请使用platonic-init
关键词:RFC、规范、文档、验证、分类法、术语

Quick Start

快速开始

Refine Existing Specifications

优化现有规范

Read
references/refine-specs.md
to run a comprehensive refinement that:
  • Validates cross-references and dependencies
  • Checks taxonomy compliance
  • Updates history, index, and terminology files
  • Reports errors and warnings
阅读
references/refine-specs.md
以运行全面的优化操作,包括:
  • 验证交叉引用和依赖关系
  • 检查分类法合规性
  • 更新历史记录、索引和术语文件
  • 报告错误和警告

Available Operations

可用操作

This skill provides 7 distinct operations, each defined in
references/
:
OperationReference FilePurpose
Refine
refine-specs.md
Comprehensive validation and update
Generate History
generate-history.md
Update RFC change history
Generate Index
generate-index.md
Update RFC index with quick links
Generate Namings
generate-namings.md
Extract and organize terminology
Validate Consistency
validate-consistency.md
Check cross-references and metadata
Check Taxonomy
check-taxonomy.md
Verify terminology consistency
Check Compliance
check-standard-compliance.md
Validate against RFC standard
See references/REFERENCE.md for detailed operation guides and examples.
本Skill提供7种不同的操作,每种操作都在
references/
目录中有定义:
操作参考文件用途
优化
refine-specs.md
全面的验证与更新
生成历史记录
generate-history.md
更新RFC变更历史
生成索引
generate-index.md
更新带快速链接的RFC索引
生成命名文件
generate-namings.md
提取并整理术语
验证一致性
validate-consistency.md
检查交叉引用和元数据
检查分类法
check-taxonomy.md
验证术语一致性
检查合规性
check-standard-compliance.md
验证是否符合RFC标准
查看references/REFERENCE.md获取详细的操作指南和示例。

Templates

模板

Templates are provided in
assets/
as references:
  • rfc-standard.md.template
    - RFC format and guidelines
  • rfc-history.md.template
    - Change history structure
  • rfc-index.md.template
    - RFC index format
  • rfc-namings.md.template
    - Terminology reference format
  • rfc-template.md
    - Individual RFC template
Templates use
{{PROJECT_NAME}}
placeholders.
模板在
assets/
目录中提供,作为参考:
  • rfc-standard.md.template
    - RFC格式与指南
  • rfc-history.md.template
    - 变更历史结构
  • rfc-index.md.template
    - RFC索引格式
  • rfc-namings.md.template
    - 术语参考格式
  • rfc-template.md
    - 单个RFC文档模板
模板使用
{{PROJECT_NAME}}
作为占位符。

Best Practices

最佳实践

  1. Always read the reference file before executing an operation
  2. Check
    rfc-standard.md
    in your specs directory for project conventions
  3. Update history when making changes to RFCs
  4. Run validation operations regularly to maintain consistency
  5. Keep terminology current - deprecated terms belong in history, not namings
  1. 执行操作前务必阅读参考文件
  2. 查看规范目录中的
    rfc-standard.md
    了解项目约定
  3. 修改RFC时更新历史记录
  4. 定期运行验证操作以保持一致性
  5. 保持术语更新 - 已弃用的术语应放入历史记录,而非命名文件中

Dependencies

依赖项

  • Read/write access to specifications directory
  • Markdown file support
  • Date manipulation for history tracking
  • 对规范目录的读写权限
  • 支持Markdown文件
  • 用于历史记录跟踪的日期处理功能