[{"data":1,"prerenderedAt":153},["ShallowReactive",2],{"use-case-en-technical-documentation":3,"use-case-features-en-technical-documentation":137,"use-case-related-en-technical-documentation":146},{"id":4,"title":5,"body":6,"description":117,"extension":118,"meta":119,"navigation":132,"path":133,"seo":134,"stem":135,"__hash__":136},"pages\u002Fen\u002Fuse-cases\u002Ftechnical-documentation.md","Technical docs & API reference",{"type":7,"value":8,"toc":107},"minimark",[9,13,18,22,26,29,33,52,56,78,82,85,89],[10,11,5],"h1",{"id":12},"technical-docs-api-reference",[14,15,17],"h2",{"id":16},"who-its-for","Who it's for",[19,20,21],"p",{},"Developers, technical writers, DevRel, and teams maintaining internal wikis.",[14,23,25],{"id":24},"common-challenges","Common challenges",[19,27,28],{},"Docs drift from code; inconsistent terminology; example code is tedious to maintain.",[14,30,32],{"id":31},"how-writex-helps","How WriteX helps",[19,34,35,36,40,41,46,47,51],{},"Point WriteX at your repo ",[37,38,39],"code",{},"docs\u002F"," folder. Edit with the ",[42,43,45],"a",{"href":44},"\u002Ffeatures\u002Fmarkdown-editor","Markdown editor",". Attach existing pages so the ",[42,48,50],{"href":49},"\u002Ffeatures\u002Fai-agent","agent"," matches terminology and drafts API examples, error tables, or migration guides. Ship via Git as usual.",[14,53,55],{"id":54},"typical-workflow","Typical workflow",[57,58,59,66,69,72,75],"ol",{},[60,61,62,63,65],"li",{},"Project path = repo ",[37,64,39],{},".",[60,67,68],{},"Update Markdown on feature branches.",[60,70,71],{},"Agent fills examples from comments or OpenAPI snippets.",[60,73,74],{},"Human review, then Git commit.",[60,76,77],{},"Tag releases with doc versions.",[14,79,81],{"id":80},"practical-tips","Practical tips",[19,83,84],{},"Maintain a glossary file and attach it to agent sessions; snapshot before large agent rewrites.",[14,86,88],{"id":87},"related-features","Related features",[90,91,92,96,101],"ul",{},[60,93,94],{},[42,95,45],{"href":44},[60,97,98],{},[42,99,100],{"href":49},"AI agent",[60,102,103],{},[42,104,106],{"href":105},"\u002Ffeatures\u002Fproject-search","Project search",{"title":108,"searchDepth":109,"depth":109,"links":110},"",2,[111,112,113,114,115,116],{"id":16,"depth":109,"text":17},{"id":24,"depth":109,"text":25},{"id":31,"depth":109,"text":32},{"id":54,"depth":109,"text":55},{"id":80,"depth":109,"text":81},{"id":87,"depth":109,"text":88},"Engineers maintain READMEs and API docs beside code in WriteX—the agent keeps terminology consistent and drafts examples.","md",{"seoTitle":120,"summary":121,"audience":122,"category":123,"order":124,"related":125,"relatedCases":129},"Technical Documentation | WriteX Use Case","READMEs, API refs, and architecture notes in your repo folder.","Engineers & technical writers","professional",6,[126,127,128],"markdown-editor","ai-agent","project-search",[130,131],"open-source-docs","product-requirements",true,"\u002Fen\u002Fuse-cases\u002Ftechnical-documentation",{"title":5,"description":117},"en\u002Fuse-cases\u002Ftechnical-documentation","2KCpwbAry4s77p7kiVcYYPaSdko3xeU4ZBo-svnIK1M",[138,141,144],{"title":139,"to":140},"WYSIWYG Markdown editor","\u002Fen\u002Ffeatures\u002Fmarkdown-editor",{"title":142,"to":143},"AI writing agent","\u002Fen\u002Ffeatures\u002Fai-agent",{"title":106,"to":145},"\u002Fen\u002Ffeatures\u002Fproject-search",[147,150],{"title":148,"to":149},"Open-source documentation","\u002Fen\u002Fuse-cases\u002Fopen-source-docs",{"title":151,"to":152},"Product requirements (PRD)","\u002Fen\u002Fuse-cases\u002Fproduct-requirements",1785483020732]