Project

General

Profile

Actions

discussion #6613

closed

Interesting examples for good documentation

Added by Andreas Müller almost 7 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Highest
Category:
documentation
Target version:
Start date:
03/16/2022
Due date:
03/18/2022
% Done:

100%

Estimated time:
Severity:
normal

Description

Check if these are somehow useful for us

https://www.infoq.com/articles/ci-rest-docs?utm_source=infoqWeeklyNewsletter&utm_medium=WeeklyNL_EditorialContent_development&utm_campaign=05022017news&utm_content=b (arguments why code and documentation should go togehter, see also keywords in comment 3; however most of them are not so relevant for us)

https://github.com/PharkMillups/beautiful-docs (good list with examples, code generator tools and a few theoretical articles)

https://stripe.com/docs/api (less interesting)

http://docs.basho.com/riak/ts/1.5.2/ (less interesting)

https://jacobian.org/series/great-documentation/

Actions

Also available in: Atom PDF