Write end user documentation

OpenDataServices / standards-lab

Open Standards Lab. A web tool for users and creators of Open Standards.

https://standards-lab.readthedocs.io/

GNU Affero General Public License v3.0

2 stars 0 forks source link

Open robredpath opened 3 years ago

robredpath commented 3 years ago

The "end user" is the person who is interacting only with the front-end interface.

For early-stage standards (and for the first iteration of this project) there are, I think, two end users:

The person who's trying to develop a standard
The person who's had a link to this shared with them as they try to use the standard

robredpath commented 3 years ago

Primarily for the person who's trying to develop the standard:

Intro to data standards design - structure, modelling, iterative development practices (+ link to OS4D)
Tools for data standards design - links, advice and how to use them with Standards Lab
Your First Data Standard with Standards Lab - demo/walkthrough of a simple data standard
Standards Lab Reference - box-by-box feature descriptions

robredpath commented 3 years ago

Primarily for the person who's using this while trying to implement the standard:

Obvious guidance on what to do, written by the standard's author << our job is probably to make this space really obvious
Standards Lab Reference - box-by-box feature descriptions of just the non-schema boxes
Data Standards & Spreadsheets - a guide to using a JSON data standard to shape a spreadsheet
Using A Data Standard - setting norms around workflow, how to apply feedback, how standards fit into data ecosystems