Adding information about outdated information #470
Merged
Conversation
This file contains hidden or 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
Added a paragraph under `Documenting your processes` talking about the obsolescence of documentation.
MikeMcQuaid
reviewed
Oct 30, 2017
_articles/en-US/best-practices.md
Outdated
|
|
||
| Even if you don't use full paragraphs, jotting down bullet points is better than not writing at all. | ||
|
|
||
| Dismissing outdated information or, at least, clearly identifying it as outdated is a good practice. By clearly pointing the absence or obsolescence of documents, communities can ask for help to update or create such documentation. |
Contributor
There was a problem hiding this comment.
How about something like Remember to keep your documentation up-to-date. If you’re not able to always do this, delete your outdated documentation or indicate it is outdated so contributors know updates are welcome.?
MikeMcQuaid
approved these changes
Oct 30, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Added a paragraph under
Documenting your processestalking about the obsolescence of documentation, according to issue #468.Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.