Project

General

Profile

Actions

discussion #6613

closed

Interesting examples for good documentation

Added by Andreas Müller almost 7 years ago. Updated almost 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 #1

Updated by Andreas Müller almost 2 years ago

  • Due date set to 03/18/2022
  • Target version changed from Update Documentation to Release 5.31
  • Start date set to 03/14/2022

Maybe helpful for the discussion on Mar 18th

Actions #2

Updated by Andreas Müller almost 2 years ago

  • Start date changed from 03/14/2022 to 03/16/2022
Actions #3

Updated by Andreas Müller almost 2 years ago

  • Tracker changed from task to discussion
  • Description updated (diff)
  • Status changed from New to In Progress
  • Priority changed from New to Highest
  • % Done changed from 0 to 70

"Any interested developers, including customers, can subscribe to notifications on pull requests when the documentation is in the same repository as the code."

"Open reviews for documentation and code together"

"Bug tracking for documentation"

"JSON tester"

"Validated requests and responses"

Actions #4

Updated by Andreas Müller almost 2 years ago

  • Description updated (diff)
Actions #5

Updated by Andreas Müller almost 2 years ago

  • Status changed from In Progress to Closed
  • % Done changed from 70 to 100

Most interesting is the beautiful-docs link.

Actions

Also available in: Atom PDF