1b:I[3821,["874","static/chunks/874-5853b36c417a5f43.js","598","static/chunks/598-8e8b350c69b61725.js","735","static/chunks/735-5d5145bb0f79dc16.js","881","static/chunks/881-64080935572a77c4.js","671","static/chunks/app/%5Blocale%5D/submitted/page-9972e6b84e2d7c4f.js"],"default"] 1c:T7e7,In such common cases as

- writing specifications for new software

- writing documentation for a client on how to use software and/or how it architechured internally

- writing an API reference with usage examples

I've seen most of times people use just a plain Google Documents/Word file and share it. Some write markdown files and convert to HTML/PDF. Nowadays many start to use Notion too.

But I feel like those tools are not featured enough. Like, what good technical docs can be without some squares and arrows?

I want to be able to:

- split my documentation into tree-like structure of sections/pages, add linking between them and even include blocks from one page to another

- add and edit right in-place: diagrams, mindmaps and other schemes (PlantUML is my loved choice, but drag-n-dropping mouse-clicking editor if fine too), tables and charts (with referencing external sources like CSV), math notation (LaTeX)

- connect it somehow to code repository, so I can reference classes, function names and signatures, code parts -- main reason here is when I refactor the code, documentation is updated on commit, and therefore always kept is sync.

- all done with WYSIWIG in web, so I can easily share work in progress with my (maybe less technical) coworkers, so they can edit too or leave comments.

For me, there is AsciiDoc, which is less-known alternative to markdown, having a lots of features out of the box (plantuml and other embedding, better tables, etc). But hard to collaborate - you can only preview it locally; syncing changes only via storing it in git; other writers should be familiar with syntax too. And there is still Notion, which is very easy to collaborate on, but not extendable, so I

klkvsk 的提交内容

Ask HN: What tools do you use to write techinal documents

Ask HN: What tools do you use to write techinal documents