Documentation Standard

  • From: "Tiwari, Yogesh" <dmarc-noreply@xxxxxxxxxxxxx> (Redacted sender "Yogesh.Tiwari" for DMARC)
  • To: "oracle-l@xxxxxxxxxxxxx" <oracle-l@xxxxxxxxxxxxx>
  • Date: Thu, 28 Nov 2019 04:31:03 +0000

Guys,

I recently came about an interesting book, "Documenting Software Architecture". 
It tells you how you can standardize documentation. I m curious, how ppl/orgs 
maintain their internal documentation for DBAs?
There are all sorts of views on this, though...


  1.  Documentation platform like, confluence.
  2.  Word Docs
  3.  PyDoc type documentation
  4.  Documentation along with code, in markdown files etc.

What do you use, in your org, and if you can possibly explain, why please?

Thanks,
Yogi
Disclaimer: The information transmitted is intended for the person or entity to 
which it is addressed and may contain confidential, privileged or copyrighted 
material or attorney work product. If you receive this in error, please contact 
the sender and delete the material from any system. Any unauthorised copying, 
disclosure or distribution of the material in this e-mail is strictly 
forbidden. Any comments or statements made are not necessarily those of 
Fidelity. All e-mails may be monitored or recorded.

Other related posts: