Skip to content

Commit 2621341

Browse files
author
Igor Steinmacher
authored
Adding information about outdated information
Added a paragraph under `Documenting your processes` talking about the obsolescence of documentation.
1 parent 60a6e7f commit 2621341

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

_articles/en-US/best-practices.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Writing things down makes it easier to say no when something doesn't fit into yo
3535

3636
Even if you don't use full paragraphs, jotting down bullet points is better than not writing at all.
3737

38+
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.
39+
3840
### Write down your project's vision
3941

4042
Start by writing down the goals of your project. Add them to your README, or create a separate file called VISION. If there are other artifacts that could help, like a project roadmap, make those public as well.

0 commit comments

Comments
 (0)