gstack-style-doc 是一个文档生成类技能,用于产出一类特定风格的技术文档,该风格受 garrytan/gstack 启发,强调个人叙事、透明的推理过程与策略性的细节密度。其核心特点包括:以钩子开场,用引言、个人故事或意外数据抓住读者;展示作者的思考过程,通过“你说 X,代理说 Y”“这不是 A,这是 B”等对比句式澄清定位;使用精确数字建立可信度;采用渐进式披露结构,从钩子或故事到 30 秒快速开始、核心工作流、功能表和理念;加入对话式摩擦,如直接对读者说话、自我调侃局限;以角色拟人化呈现功能,把命令对应到具体职责。文档模板包含项目名、问题引言、个人故事、可信度数据、安装命令、核心工作流、功能概览、设计理由、延伸阅读等部分。适用于开发者工具和 CLI、带有鲜明见解的库、具有独特工作流的产品,以及希望教授方法而不仅是 API 的文档;不适合简单工具库、需要正式语气的企业文档或 API 参考文档。资料还给出反模式提醒,如不要编造个人故事、不要强行堆砌指标、不要过度叙事、不要忽略实用示例。该页面未提供具体安装命令、价格或平台限制信息。
gstack-style-doc
通用与其它
更新于 10-16 07:16