Skip to content

Commit 893993f

Browse files
authored
Explicit subject
1 parent 76bb1e7 commit 893993f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/articles/documentation-is-more-than-you-think.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The two mistakes I see many companies make:
4848

4949
- They lack a [writing and style guide](https://learn.microsoft.com/en-us/style-guide/welcome/): it's a really important document to outline the tone, style, and decisions made on content. Without it, the many "chefs" in your documentation work all over each other; every page seems to have been made by someone different (you're not writing an anthology!), and decisions are lost to time. That all means, docs also need docs!
5050

51-
- No one is responsible for it: your documentation needs a "head chef", they're the one responsible for ensuring everything is following the recipe and standards set. Generally, this should be your Senior/Staff Technical Writer or Docs Lead.
51+
- No one is responsible for the documentation: it needs a "head chef", they're the one responsible for ensuring everything is following the recipe and standards set. Generally, this should be your Senior/Staff Technical Writer or Docs Lead.
5252

5353
Investing in documentation is investing in quality. The same way you need someone to architect the words that are written for the computer so that it's clean, efficient, and maintainable, you need someone who architects the words that are written for the much less precise, imperfect, and more critical human beings.
5454

0 commit comments

Comments
 (0)