From 2995e7e53a15573c3dfa3fca61c3627f63a59ec7 Mon Sep 17 00:00:00 2001 From: Keith Hazelton Date: Thu, 12 Oct 2023 14:08:50 -0500 Subject: [PATCH] Create grouperSurveyResponses.adoc --- grouperSurveyResponses.adoc | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 grouperSurveyResponses.adoc diff --git a/grouperSurveyResponses.adoc b/grouperSurveyResponses.adoc new file mode 100644 index 0000000..6934faa --- /dev/null +++ b/grouperSurveyResponses.adoc @@ -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-*