-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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-* |