grouperSurveyResponse.adoc
- Responses to Grouper Survey Initial Recommentations -
Ensure that each 'page' or unit of documentation carries helpful metadata (tags, keywords, with a controlled vocabulary of primary terms)
-
type of documentation: How-to, tutorial, reference, explanation (ConOps)
-
context: Deployment, Tech Dev & Integration, Administration, data structures, UI guides
-
other keywords to support search terms
-
versions to which documentation applies (e.g. Grouper >= 4.7)
-
links to related documentation units
-
date created, date last modified
The above categories align fairly well with the responses to the "Improvement Priority" question on the Grouper Survey
Keep in mind creation and maintenance costs when formulating documentation guidelines
- Harvest Slack problems posed and solutions offered on Slack; -
-
Collect in a well-known, well-organized documentation resource
-
Addresses the "Same question 100 times" problem