add quentin slide

wise4rmgod · Sep 5, 2022 · 53366e0 · 53366e0
1 parent 7002e79
commit 53366e0
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 4 deletions.
diff --git a/content/post/great-documentation.md b/content/post/great-documentation.md
@@ -0,0 +1,47 @@
++++
+author = "Quentin"
+title = "Great Documentation"
+date = "2022-09-02"
+description = "Technical writing mentorship program first meetup"
++++
+
+## Why is great documentation important?
+
+- Important for scalability — first line of defense against the tsunami of user questions 
+
+- Great marketing tool – great documentation helps attract and sustain communities
+
+- Reflection on the quality of the product. Poor and lazy documentation = poor quality product
+
+## What makes great documentation?
+
+
+- Detailed. Answers any questions the user might be thinking.
+
+- Well organized (specific articles for specific purposes)
+
+- Well-written (proper grammar, spelling, and punctuation)
+
+- Interactivity (code samples, diagrams, screenshots)
+
+- Lots of guidance (walk-throughs, exercises, tutorials)
+
+
+## How to write great documentation?
+
+
+- Create a list of all the topics you want to cover 
+
+- Put yourself in the users’ shoes. Think about what the user might be thinking.
+
+- Use lots of tools: Grammarly, GitBook, Postman, etc.
+
+- Test your documentation yourself. Have other people test it and see if it works for them.
+
+- Use lots of examples.
+
+- Gather feedback from users! 
+
+
+
+
diff --git a/content/post/intro.md b/content/post/intro.md
@@ -1,7 +1,7 @@
 +++
 author = "Wisdom"
-title = "Senior Technical Writer @MongoDb Realm"
-date = "2022-08-01"
+title = "Introduction To Technical Writer"
+date = "2022-09-10"
 description = "This is a technical writing introduction"
 +++
 
@@ -11,4 +11,3 @@ Socials:
 - [LinkedIn](https://www.linkedin.com/in/wisdom-nwokocha-76212a77/) 
 - [Twitter](https://twitter.com/Joklinztech)
 
-Body of your message
diff --git a/content/post/style-guide-collection.md b/content/post/style-guide-collection.md
@@ -1,4 +1,10 @@
-# Style guides
++++
+author = "Barrie"
+title = "Style Guide"
+date = "2022-09-16"
+description = "Technical writing mentorship program fourth meetup"
++++
+## Style guides
 
 Submitted by <https://github.com/barriebyron> for the September 2022 mentoring program hosted by Wisdom.