Discussion on: Where is the best place to put your project documentation?

View post

Paramanantham Harrison • Feb 23 '19 • Edited

Readme for setup and running instructions
Github pages for style guides and best practices documents
Wiki for trouble shooting guide (usually not used by me often personally)
Docasuarus for all implementation details and guides for development team

Its always good to put in one place, we use dacasuarus at Jobbatical for most things.

docasuarus (open source by facebook) and readme are the go to place for finding documents. Rest all will be secondary and often missed out

Camilo Martinez • Feb 24 '19 • Edited

I think Docusaurus is open source project for Facebook, not Google.

Paramanantham Harrison • Feb 24 '19

Yes, by Facebook. Will edit my comment. Thanks

Adam Brandizzi • Feb 24 '19

Good points! It is very relevant to remember that there are different documentation types. Also, I really like that your listing maps so well to the categories from one of my favorite articles: divio.com/blog/documentation/ I guess you may like it, and @chrisrhymes too! :-)

C.S. Rhymes • Feb 24 '19

I hadn’t heard of docasaurus before. I’ll check it out!