[{"data":1,"prerenderedAt":146},["ShallowReactive",2],{"use-case-zh-technical-documentation":3,"use-case-features-zh-technical-documentation":130,"use-case-related-zh-technical-documentation":139},{"id":4,"title":5,"body":6,"description":110,"extension":111,"meta":112,"navigation":125,"path":126,"seo":127,"stem":128,"__hash__":129},"pages\u002Fzh\u002Fuse-cases\u002Ftechnical-documentation.md","技术文档与 API 说明",{"type":7,"value":8,"toc":100},"minimark",[9,13,17,21,24,27,31,45,48,72,75,78,81],[10,11,5],"h1",{"id":12},"技术文档与-api-说明",[14,15,16],"h2",{"id":16},"适合谁",[18,19,20],"p",{},"开发工程师、技术写作者、DevRel 与需要维护内部 Wiki 的团队。",[14,22,23],{"id":23},"常见痛点",[18,25,26],{},"文档与代码仓库分离导致过期；多人协作术语不统一；补示例代码枯燥。",[14,28,30],{"id":29},"writex-如何助力","WriteX 如何助力",[18,32,33,34,39,40,44],{},"WriteX 项目直接打开 Git 仓库 docs 目录，",[35,36,38],"a",{"href":37},"\u002Ffeatures\u002Fmarkdown-editor","Markdown 编辑器"," 所见即所得改文档。Agent 读取现有章节 ",[35,41,43],{"href":42},"\u002Ffeatures\u002Fcontext-attachments","保持术语一致","，生成 API 示例、错误码表或迁移指南草稿。配合 Git 提交做正式发布流程。",[14,46,47],{"id":47},"典型工作流",[49,50,51,60,63,66,69],"ol",{},[52,53,54,55,59],"li",{},"将 WriteX 项目指向 repo 的 ",[56,57,58],"code",{},"docs\u002F","。",[52,61,62],{},"新功能分支上更新对应 Markdown。",[52,64,65],{},"Agent 根据代码注释或 OpenAPI 片段补示例。",[52,67,68],{},"人工 Review 后 Git commit。",[52,70,71],{},"发版时打 tag 同步文档版本。",[14,73,74],{"id":74},"实用技巧",[18,76,77],{},"把术语表单独成文并附加给 Agent；大改前快照，避免 Agent 误删警告段落。",[14,79,80],{"id":80},"相关功能",[82,83,84,88,94],"ul",{},[52,85,86],{},[35,87,38],{"href":37},[52,89,90],{},[35,91,93],{"href":92},"\u002Ffeatures\u002Fai-agent","AI Agent",[52,95,96],{},[35,97,99],{"href":98},"\u002Ffeatures\u002Fproject-search","项目内搜索",{"title":101,"searchDepth":102,"depth":102,"links":103},"",2,[104,105,106,107,108,109],{"id":16,"depth":102,"text":16},{"id":23,"depth":102,"text":23},{"id":29,"depth":102,"text":30},{"id":47,"depth":102,"text":47},{"id":74,"depth":102,"text":74},{"id":80,"depth":102,"text":80},"工程师与技术写作者用 WriteX 维护 README、API 文档与架构说明，Agent 保持术语一致并补全示例。","md",{"seoTitle":113,"summary":114,"audience":115,"category":116,"order":117,"related":118,"relatedCases":122},"技术文档与 API 说明 | WriteX 使用场景","README、API、架构文，和代码仓库同文件夹。","工程师与 TW","professional",6,[119,120,121],"markdown-editor","ai-agent","project-search",[123,124],"open-source-docs","product-requirements",true,"\u002Fzh\u002Fuse-cases\u002Ftechnical-documentation",{"title":5,"description":110},"zh\u002Fuse-cases\u002Ftechnical-documentation","KAUjbNTZiQotpDsglYsRuoLRkFzkkZPAtjcnwNucii8",[131,134,137],{"title":132,"to":133},"所见即所得 Markdown 编辑器","\u002Fzh\u002Ffeatures\u002Fmarkdown-editor",{"title":135,"to":136},"AI 写作 Agent","\u002Fzh\u002Ffeatures\u002Fai-agent",{"title":99,"to":138},"\u002Fzh\u002Ffeatures\u002Fproject-search",[140,143],{"title":141,"to":142},"开源项目文档维护","\u002Fzh\u002Fuse-cases\u002Fopen-source-docs",{"title":144,"to":145},"产品需求文档（PRD）","\u002Fzh\u002Fuse-cases\u002Fproduct-requirements",1785483019433]