3 ms·
For more of a process on how to get docs cycle through a dev review - The oxide computer RFD process - https://oxide.computer/blog/rfd-1-requests-for-discussion
by gautamdivgi 4y ago
For more of a process on how to get docs cycle through a dev review - The oxide computer RFD process - https://oxide.computer/blog/rfd-1-requests-for-discussion https://oxide.computer/blog/rfd-1-requests-for-discussion. I tried to use something similar for my team but got a lot of eye rolls that docs would need source control. We use a wiki but it's messy and not a lot of review control. Writing the doc is one thing. Making sure it's effectively communicated, reviewed, versioned and published should also be a part of the documentation process.
One pesky little detail is that documents take a lot of thought to write and this translates into a good bit of time to get a document out for review. If you have a "how fast are you closing your JIRA tickets" manager, it can be hard to justify and will come back to bite you (unfairly so, but such is the life of a sw. engineer).