add doc as code

README.md

@@ -36,3 +36,16 @@ If you'd like to suggest a change to the data or the way it's organized here, pl
 - Update the README.md with any community writing programs you want to add or update.
 - Make sure the list of programs is still in alphabetical order.
 - Create the pull request and explain your changes. We'll merge it in or reply as quickly as possible.
+
+
+## Test the doc
+
+### Development server
+```
+hugo serve
+```
+
+### Build the doc
+```
+hugo
+```

config.toml

@@ -4,7 +4,7 @@ title = 'TWR'
 author = "Nwokocha Wisdom Maduabuchi"
 copyright = "Copyright © 2022, Wisdom Nwokocha all rights reserved."
 relativeURLs = true
-paginate = 5
+paginate = 15
 enableInlineShortcodes = true
 missingContentMessage = "Page not found..."
 missingBackButtonLabel = "Back to home page"

content/post/Introduction-to-web-development.md

@@ -1,10 +1,12 @@
 +++
 author = "Solomon"
-title = "Introduction to Wed development "
+title = "Introduction to Web development "
 date = "2022-10-22"
 description = "Technical writing mentorship program fifth meetup"
 +++
 
+{{< youtube RNZT3ICPW1Y >}}
+
 Web development is the work involved in developing a website for the Internet or an intranet. Web development can range from developing a simple single static page of plain text to complex web applications.
 Before you can become a web developer, or start building those application, you need to understand the basics and fundamentals of web development.
 

content/post/introduction-to-doc-as-code.md

@@ -0,0 +1,64 @@
++++
+author = "Wisdom"
+title = "Introduction to doc as code"
+date = "2022-11-02"
+description = "Technical writing mentorship program talking about doc as code"
++++
+
+Writing, revising, and publishing procedures can be made more efficient using the documentation technique and practice known as "docs as code."
+
+Docs as Code, as the name suggests, handles all documentation like a codebase. Docs as Code recommends writing in a plaintext markup language like Markdown, pushing that documentation through an automated pipeline that tests the quality of the writing, and ultimately building and publishing the documentation to the public.
+
+The actual documents are managed using some version control like Git.
+
+## Docs-as-code features
+
+- Writing format
+- Static site generator
+- Version control system
+- Continuous integration
+- Collaborating with other writers using version control
+- Running validation checks
+
+## The advantages of using a docs-as-code approach?
+
+- **Developer doc contribution:** It's easier for developers to contribute to the docs themselves. 
+
+- **Collaboration:** Using the same tools and procedures facilitates collaboration between authors, developers, and users.
+
+## How to set up docs as code
+In this example, you will use docusaurus to create your documentation site.
+
+### Prerequisite
+
+- Install Vscode
+- Install Nodejs
+
+### Install docusaurus
+
+The easiest way to install Docusaurus is to use the command line tool that helps you scaffold a skeleton Docusaurus website.
+```js
+npx create-docusaurus@latest my-website classic
+```
+
+### Running the development server
+To preview your changes as you edit the files, you can run a local development server that will serve your website and reflect the latest changes.
+
+### Change folder
+
+```js
+cd my-website
+```
+
+### Run the preview mode with the command below.
+
+```js
+npm run start
+```
+
+### Build​
+Docusaurus is a modern static website generator, so we need to build the website into a directory of static contents and put it on a web server to view it. To build the website:
+
+```js
+npm run build
+```

content/post/introduction-to-knowledgebase.md

@@ -5,6 +5,7 @@ date = "2022-10-09"
 description = "Technical writing mentorship program fifth meetup"
 +++
 
+{{< youtube VZI3IKJhro0 >}}
 ## Agenda
 
 This deck covers the following topics:

content/post/subjectmatterexpert.md

@@ -0,0 +1,43 @@
++++
+author = "Clarissa"
+title = "Subject Matter Expert"
+date = "2022-10-14"
+description = "Technical writing mentorship program fifth meetup"
++++
+
+{{< youtube F2lFRFBJRAY >}}
+
+## Discussion
+
+- How I got into technical writing
+- Who are subject matter experts 
+- Why do they matter 
+- Subject matter experts as a best practice in technical writing
+- Tell a story
+
+## My journey into technical writing 
+- Loved writing as a child 
+- Traditional copywriter
+- Followed my curiosity with technology 
+- Specialization
+- Web3 needs strong communicators for adoption 
+
+## Who qualifies as a subject matter expert 
+
+- People with first-hand experience 
+- People building the technology you’re writing about: engineers, founders, developers, CTOs
+- Academics: people versed in theory and history 
+- End-users: people using the technology you’re writing about
+
+## Why do they matter
+- Misinformation and fake news
+- Clickbait
+- Vaporware 
+- Scams 
+
+## Best practise
+- Show don’t tell 
+- Direct quotes
+- Paraphrase, cite, attribute
+- Establish rapport and trust 
+

public/index.html

@@ -289,7 +289,17 @@ <h1 class="mt-1.5 mb-3 text-3xl font-bold">Technical Writing Resources</h1>
 
 
 <section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
-  <h2 class="!my-0 pb-1 !leading-none">Introduction to Wed development </h2>
+  <h2 class="!my-0 pb-1 !leading-none">Introduction to doc as code</h2>
+  <time class="text-sm opacity-60">Nov 2, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/introduction-to-doc-as-code/"></a>
+</section>
+
+
+
+
+
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Introduction to Web development </h2>
   <time class="text-sm opacity-60">Oct 22, 2022</time>
   <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/introduction-to-web-development/"></a>
 </section>
@@ -298,6 +308,16 @@ <h2 class="!my-0 pb-1 !leading-none">Introduction to Wed development </h2>
 
 
 
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Subject Matter Expert</h2>
+  <time class="text-sm opacity-60">Oct 14, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/subjectmatterexpert/"></a>
+</section>
+
+
+
+
+
 <section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
   <h2 class="!my-0 pb-1 !leading-none">Introduction to KnowledgeBase </h2>
   <time class="text-sm opacity-60">Oct 9, 2022</time>
@@ -337,12 +357,55 @@ <h2 class="!my-0 pb-1 !leading-none">Git Essential Training - The Basics</h2>
 
 
 
-<nav class="mt-24 flex">
-
-
-  <a class="btn ml-auto" href="./page/2/">Next Page →</a>
-
-</nav>
+
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Introduction to Command Line Interface </h2>
+  <time class="text-sm opacity-60">Sep 23, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/commandline-interface/"></a>
+</section>
+
+
+
+
+
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Information Architecture and Topic-based writing </h2>
+  <time class="text-sm opacity-60">Sep 16, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/informationarchitecture/"></a>
+</section>
+
+
+
+
+
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Introduction To Technical Writer</h2>
+  <time class="text-sm opacity-60">Sep 10, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/intro/"></a>
+</section>
+
+
+
+
+
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Use Of English</h2>
+  <time class="text-sm opacity-60">Sep 9, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/useofenglish/"></a>
+</section>
+
+
+
+
+
+<section class="relative my-10 first-of-type:mt-0 last-of-type:mb-0">
+  <h2 class="!my-0 pb-1 !leading-none">Great Documentation</h2>
+  <time class="text-sm opacity-60">Sep 2, 2022</time>
+  <a class="absolute inset-0" href="https://technicalwriterresources.pages.dev/post/great-documentation/"></a>
+</section>
+
+
+
 
 
 

public/index.xml

@@ -7,9 +7,19 @@
     <generator>Hugo -- gohugo.io</generator>
     <language>en-us</language>
     <copyright>Copyright © 2022, Wisdom Nwokocha all rights reserved.</copyright>
-    <lastBuildDate>Sat, 22 Oct 2022 00:00:00 +0000</lastBuildDate><atom:link href="https://technicalwriterresources.pages.dev/index.xml" rel="self" type="application/rss+xml" />
+    <lastBuildDate>Wed, 02 Nov 2022 00:00:00 +0000</lastBuildDate><atom:link href="https://technicalwriterresources.pages.dev/index.xml" rel="self" type="application/rss+xml" />
     <item>
-      <title>Introduction to Wed development </title>
+      <title>Introduction to doc as code</title>
+      <link>https://technicalwriterresources.pages.dev/post/introduction-to-doc-as-code/</link>
+      <pubDate>Wed, 02 Nov 2022 00:00:00 +0000</pubDate>
+
+      <guid>https://technicalwriterresources.pages.dev/post/introduction-to-doc-as-code/</guid>
+      <description>Writing, revising, and publishing procedures can be made more efficient using the documentation technique and practice known as &amp;ldquo;docs as code.&amp;rdquo;
+Docs as Code, as the name suggests, handles all documentation like a codebase. Docs as Code recommends writing in a plaintext markup language like Markdown, pushing that documentation through an automated pipeline that tests the quality of the writing, and ultimately building and publishing the documentation to the public.</description>
+    </item>
+
+    <item>
+      <title>Introduction to Web development </title>
       <link>https://technicalwriterresources.pages.dev/post/introduction-to-web-development/</link>
       <pubDate>Sat, 22 Oct 2022 00:00:00 +0000</pubDate>
 
@@ -18,13 +28,22 @@
 You can read through the complete beginner guide to web development on MDN</description>
     </item>
 
+    <item>
+      <title>Subject Matter Expert</title>
+      <link>https://technicalwriterresources.pages.dev/post/subjectmatterexpert/</link>
+      <pubDate>Fri, 14 Oct 2022 00:00:00 +0000</pubDate>
+
+      <guid>https://technicalwriterresources.pages.dev/post/subjectmatterexpert/</guid>
+      <description> Discussion How I got into technical writing Who are subject matter experts Why do they matter Subject matter experts as a best practice in technical writing Tell a story My journey into technical writing Loved writing as a child Traditional copywriter Followed my curiosity with technology Specialization Web3 needs strong communicators for adoption Who qualifies as a subject matter expert People with first-hand experience People building the technology you’re writing about: engineers, founders, developers, CTOs Academics: people versed in theory and history End-users: people using the technology you’re writing about Why do they matter Misinformation and fake news Clickbait Vaporware Scams Best practise Show don’t tell Direct quotes Paraphrase, cite, attribute Establish rapport and trust </description>
+    </item>
+
     <item>
       <title>Introduction to KnowledgeBase </title>
       <link>https://technicalwriterresources.pages.dev/post/introduction-to-knowledgebase/</link>
       <pubDate>Sun, 09 Oct 2022 00:00:00 +0000</pubDate>
 
       <guid>https://technicalwriterresources.pages.dev/post/introduction-to-knowledgebase/</guid>
-      <description>Agenda This deck covers the following topics:
+      <description> Agenda This deck covers the following topics:
 User Guides Troubleshooting Guides Installation Guides Integration Guides White-papers Knowledge base Importance of Technical Writing Drives the technical vision and attention on knowledge. Maps the information for any organization. Aligns processes with information. Brings up front the value of the resources. Highlights the obvious. Layers data based on history and evolution. Case Study- Stripe- What- https://stripe.com/docs How- https://support.stripe.com/ Where- https://stripe.com/docs/products </description>
     </item>