search

JuliaDynamics / GoodScientificCodeWorkshop

A workshop on writing good scientific code.
MIT License
247 stars 19 forks source link

add resources about docs #2

Closed lucaferranti closed 2 years ago

lucaferranti commented 2 years ago

This PR adds a couple of resources about documentation that I found valuable when I got started.

The first is a link to this blogpost which discusses how to structure docs

The second is a link to Write The Docs community, they have plenty of resources/activities for software documentation and technical writing in general

Datseris commented 2 years ago

This "The Grand Unified Theory of Documentation" is similar to what I propose "different depths of exposition". I guess my one slide on these different depths could be expanded to more slides that discusses more explicitly this proposed system. However, one thing I depart from this theory is that I do not consider these levels orthogonal, I consider them hierarchical. Not sure which one is more "correct".