Difference between revisions of "Documentation"

From Open Food Facts wiki
Jump to navigation Jump to search
(Created page with "* Product Opener documentation (web) * Old API documentation === Documentation roadmap === [https://github.com/openfoodfacts/api-doc...")
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
* [[API|Old API documentation]]
 
* [[API|Old API documentation]]
  
=== Documentation roadmap ===
+
=== 2021 Documentation roadmap ===
  
 
[https://github.com/openfoodfacts/api-documentation/projects Project tracking on GitHub]
 
[https://github.com/openfoodfacts/api-documentation/projects Project tracking on GitHub]
 
* Set up a bi-monthly call for documentation
 
* Set up a bi-monthly call for documentation
 +
==== Set up a process to make publication a breeze ====
 
* Publish the new documentation to our new servers
 
* Publish the new documentation to our new servers
 
* Automate the publication of the documentation
 
* Automate the publication of the documentation
* Document assumptions and things we (d/w)on't do
+
* Deprecate the old wiki doc
 +
 
 +
==== Set up a process to keep documentation fresh ====
 
* Keep the documentation on par with the API
 
* Keep the documentation on par with the API
 
* Generate new separate, fast-moving documentation from the questions in #api or #general, and consider integrating some of it in the main documentation
 
* Generate new separate, fast-moving documentation from the questions in #api or #general, and consider integrating some of it in the main documentation
 +
 +
==== Improve the documentation ====
 +
* Document assumptions and things we (d/w)on't do
 +
[[Category:API]]

Revision as of 15:15, 5 February 2021

2021 Documentation roadmap

Project tracking on GitHub

  • Set up a bi-monthly call for documentation

Set up a process to make publication a breeze

  • Publish the new documentation to our new servers
  • Automate the publication of the documentation
  • Deprecate the old wiki doc

Set up a process to keep documentation fresh

  • Keep the documentation on par with the API
  • Generate new separate, fast-moving documentation from the questions in #api or #general, and consider integrating some of it in the main documentation

Improve the documentation

  • Document assumptions and things we (d/w)on't do