Skip to content

Commit

Permalink
Create grouperSurveyResponses.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
khazelton authored Oct 12, 2023
1 parent aea7bc5 commit 2995e7e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions grouperSurveyResponses.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
=== 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 problem posed and solutions offered on Slack; Collect in a well-known documentation resource-*

0 comments on commit 2995e7e

Please sign in to comment.