工程开发
BattleScope avatar

BattleScope

简化 BattleScope 功能的技术文档编写,确保 API、前端及架构层的一致性。

简介

Feature Documenter 是 BattleScope 生态系统中开发人员和架构师必备的工程工具。它自动化技术规范的创建与维护,确保每个新功能、API 端点或服务增强均符合代码库的严格标准。通过在产品、功能、技术及架构层面强制执行统一结构,此技能可防止文档过时,并确保交叉引用的规范保持同步。

本工具专为管理分布式微服务的开发人员设计,提供功能规范、OpenAPI 文档与前端实现细节的模板。它有助于创建 IMPLEMENTATION_SUMMARY.md 文件,用以记录关键技术决策、遇到的挑战以及未来迭代的维护指导。无论您是在实现新服务、优化现有 API,还是记录系统级的可观测性需求,此技能都能确保您的文档与代码库同样强健。

  • 自动生成标准化的 feature-spec.md、openapi-spec.md 及 frontend-spec.md 模板。

  • 维护 docs/features/ 及 docs/technical-specifications/ 目录结构的一致性。

  • 追踪功能状态与路线图进度,以确保开发周期的透明度。

  • 记录技术债务与架构设计决策,以支持长期的可维护性。

  • 确保文档与已实现的微服务(Ingestion、Enrichment、Battle、Search、Notification 及 BFF)之间的同步。

  • 在新功能的设计阶段调用此技能,以搭建文档需求架构。

  • 在修改 API 合约或变更领域服务边界时,使用此技能进行增量更新。

  • 务必更新 IMPLEMENTATION_SUMMARY.md,记录开发过程中的发现,以协助团队协作。

  • 对所有文档皆采用既定的模板,以符合 V3 微服务架构标准。

  • 此技能需要与特定功能路径相关的输入;在初始化新文档集时,请确保提供正确的 <feature-name>

仓库统计

Star 数
0
Fork 数
0
Open Issue 数
0
主要语言
HTML
默认分支
main
同步状态
空闲
最近同步时间
2026年5月4日 00:59
在 GitHub 查看