Skip to content
Permalink
main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

iam-knowledge-bits/grouperSurveyResponses.adoc

Go to file
 
 
Cannot retrieve contributors at this time
22 lines (14 sloc) 968 Bytes
Raw Blame
Open in GitHub Desktop

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