Ask HN: How to write techincal documentation for complex systems?
I'm a junior dev in a large company and after a few small projects I got an assignment to write a technical document for the system my team develops and supports. The document will then be used internally between developers, especially newcomers.
The system is made of out of the box enterprise solutions, custom software, a bunch of APIs, numerous SQL and server instances, legacy business code, web apps etc. There are bits and pieces of documentation for some of the parts but there is no complete document where all of the ins and outs of the system are explained in a readable and understandable way.
I'll have help from senior devs and architects but this is mainly my task. Are there any articles, tutorials, books to read and can you give me advice how to start, what to look for and what to avoid before I jump into this rabbit hole?
The system is made of out of the box enterprise solutions, custom software, a bunch of APIs, numerous SQL and server instances, legacy business code, web apps etc. There are bits and pieces of documentation for some of the parts but there is no complete document where all of the ins and outs of the system are explained in a readable and understandable way.
I'll have help from senior devs and architects but this is mainly my task. Are there any articles, tutorials, books to read and can you give me advice how to start, what to look for and what to avoid before I jump into this rabbit hole?