一键安装此套包中的所有插件:
42plugin install riekelt/kit/technical-writerriekelt
用于记录架构决策(ADR)或决策日志,将聊天中的技术选型、拒绝理由及替代方案转化为标准化文档。
riekelt
当业务流程、工作流或系统交互需要可视化时,使用此插件生成 PlantUML 等格式的图表。它提供从 ArchiMate 到 PlantUML 的符号阶梯及维护规则,将难以用文字描述的复杂逻辑转化为清晰的图形文档。
riekelt
用于编写 HTTP API、消息队列、DTO 及 Webhook 等机器接口的契约文档,规范字段语义与错误定义。
riekelt
为代码库或目录启动遗留文档整理活动,帮助系统化地补充和完善现有项目的文档内容。
riekelt
以全新视角审查技术文档,确保符合写作规范。仅进行审阅而不修改内容,适用于发布前的最终质量把关。
riekelt
基于当前代码库对遗留文档进行校验或更新,确保文档内容与实际系统行为一致。只读模式,仅生成分析结果,不修改代码。
riekelt
用于编写运行手册、迁移指南等需按步骤执行的运维文档,内置风险标识与故障排查规范。
riekelt
用于编写更新日志、发布说明或工作完成后的“已交付”摘要。提供条目格式、交接模板及诚实性规范,适用于完成重要工作后总结成果。
riekelt
用于为缺失或过时的遗留系统重建准确文档。通过代码调研、证据层级和覆盖率清单,确保文档与代码实际行为一致。
riekelt
用于编写提案、RFC、设计规范或迁移计划。内置标准骨架与完整性检查,辅助清晰阐述变更理由与设计决策。
riekelt
用于编写故障后报告、根因分析及事件复盘。提供无责框架、基于证据的时间线及行动项,将临时沟通转化为持久文档。
riekelt
用于审查、重写或编辑他人技术文本,或在交付前进行最终检查。内置严重性映射、发现格式及交付清单,确保文档质量。
riekelt
用于编写或修订各类技术文档,内置风格规范与禁用词列表,确保内容清晰且易于快速阅读。
riekelt
用于创建或优化追踪系统中的史诗、故事、任务及缺陷报告。提供标准化的工单骨架与验收标准,将讨论或计划转化为清晰可执行的任务项。