Re:Ask HN: What is key to good technical documentation?
by ka0lin on Sunday September 08, 2019 @08:49AM
(#20910240)
Is this an improvement over for example the Eclipse foundation's pile of high level architecture, bug database and here be dragons-areas?
* High level architecture (what pieces talk to each other, how they communicate, what they do)
* A list of 'here be dragons' areas, places where the code is gnarly
* A bug database, which will give you history of decisions
Then I'd ask the manager/product owner for a requirements document (or documents), as that should be something a non technical person can/has put together.
Frankly, though outside the scope of your question, I would also look at hiring one of the departed senior devs on a contract basis, just to ask questions of. I have offered this for the past few jobs I have left and there are times when 15 minutes of my time could save a few hours of investigation.