Add Documentation traits section to style-guide.md #561
Conversation
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
Signed-off-by: Derek Reese <cyb.tachyon@gmail.com>
OBWANDO
approved these changes
Jun 16, 2021
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a follow-up to our discussion around style-guide voice, tone, and docs PR checklists.
We've previously discussed prescriptive documentation - let's use the phrase "Task-Oriented Docs". This matches the approach that has been used on Lumberyard docs, and I believe it could be used to inform voice & tone guidelines for our docs as a whole.
Very open to edits/feedback/discussion around what traits are important and verbiage for the additions.