diff --git a/README.md b/README.md index 4677c4c..caaef30 100644 --- a/README.md +++ b/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 +``` \ No newline at end of file diff --git a/config.toml b/config.toml index 3edcc44..09e1a76 100644 --- a/config.toml +++ b/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" diff --git a/content/post/Introduction-to-web-development.md b/content/post/Introduction-to-web-development.md index 65bef56..81047f7 100644 --- a/content/post/Introduction-to-web-development.md +++ b/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. diff --git a/content/post/introduction-to-doc-as-code.md b/content/post/introduction-to-doc-as-code.md new file mode 100644 index 0000000..b33ea60 --- /dev/null +++ b/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 +``` \ No newline at end of file diff --git a/content/post/introduction-to-knowledgebase.md b/content/post/introduction-to-knowledgebase.md index c830e78..ca39e53 100644 --- a/content/post/introduction-to-knowledgebase.md +++ b/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: diff --git a/content/post/subjectmatterexpert.md b/content/post/subjectmatterexpert.md new file mode 100644 index 0000000..beea7d7 --- /dev/null +++ b/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 + diff --git a/public/index.html b/public/index.html index d40189e..a60c39e 100644 --- a/public/index.html +++ b/public/index.html @@ -289,7 +289,17 @@

Technical Writing Resources

-

Introduction to Wed development

+

Introduction to doc as code

+ + +
+ + + + + +
+

Introduction to Web development

@@ -298,6 +308,16 @@

Introduction to Wed development

+
+

Subject Matter Expert

+ + +
+ + + + +

Introduction to KnowledgeBase

@@ -337,12 +357,55 @@

Git Essential Training - The Basics

- + +
+

Introduction to Command Line Interface

+ + +
+ + + + + +
+

Information Architecture and Topic-based writing

+ + +
+ + + + + +
+

Introduction To Technical Writer

+ + +
+ + + + + +
+

Use Of English

+ + +
+ + + + + +
+

Great Documentation

+ + +
+ + + diff --git a/public/index.xml b/public/index.xml index 5ec2ddf..cc08e8e 100644 --- a/public/index.xml +++ b/public/index.xml @@ -7,9 +7,19 @@ Hugo -- gohugo.io en-us Copyright © 2022, Wisdom Nwokocha all rights reserved. - Sat, 22 Oct 2022 00:00:00 +0000 + Wed, 02 Nov 2022 00:00:00 +0000 - Introduction to Wed development + Introduction to doc as code + https://technicalwriterresources.pages.dev/post/introduction-to-doc-as-code/ + Wed, 02 Nov 2022 00:00:00 +0000 + + https://technicalwriterresources.pages.dev/post/introduction-to-doc-as-code/ + Writing, revising, and publishing procedures can be made more efficient using the documentation technique and practice known as &ldquo;docs as code.&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. + + + + Introduction to Web development https://technicalwriterresources.pages.dev/post/introduction-to-web-development/ Sat, 22 Oct 2022 00:00:00 +0000 @@ -18,13 +28,22 @@ You can read through the complete beginner guide to web development on MDN + + Subject Matter Expert + https://technicalwriterresources.pages.dev/post/subjectmatterexpert/ + Fri, 14 Oct 2022 00:00:00 +0000 + + https://technicalwriterresources.pages.dev/post/subjectmatterexpert/ + 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 + + Introduction to KnowledgeBase https://technicalwriterresources.pages.dev/post/introduction-to-knowledgebase/ Sun, 09 Oct 2022 00:00:00 +0000 https://technicalwriterresources.pages.dev/post/introduction-to-knowledgebase/ - Agenda This deck covers the following topics: + 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 diff --git a/public/page/2/index.html b/public/page/2/index.html deleted file mode 100644 index 67471ce..0000000 --- a/public/page/2/index.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - TWR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- TWR - -
- - - - - -
- - - - - - - - -
-
- - -
- - - - - - - - - - - - - - - - - -
-

Introduction to Command Line Interface

- - -
- - - - - -
-

Information Architecture and Topic-based writing

- - -
- - - - - -
-

Introduction To Technical Writer

- - -
- - - - - -
-

Use Of English

- - -
- - - - - -
-

Great Documentation

- - -
- - - - - - - - -
- - - - - diff --git a/public/post/adyen/index.html b/public/post/adyen/index.html deleted file mode 100644 index 85e18a0..0000000 --- a/public/post/adyen/index.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Senior Technical Writer @Adyen - TWR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- TWR - -
- - - - - -
- - - - - - - - -
-
- - -
- - -
-
-

Senior Technical Writer @Adyen

- - -
- - - - - · - Wisdom - -
- -
- -

Title: Technical Writer

-

Job Location: Remote

-

Level: Senior

-

Do you enjoy working on the nitty gritty, but also looking at the bigger picture? Do you love to break down complex text into easy to understand content? Are you able to shift focus and tone according to different audiences?

-

Due to the growth of the company we are looking for multiple Technical Writers to join the team who understand the technical details and can write documentation for developers interested in integrating with our APIs or SDKs.

-

You will be part of our development team, based in Amsterdam. Here, you will get familiar with and work on the payment industry’s most advanced and robust platform.

-

Apply

-

Subscribe to my newsletter for more jobs and writing tips in your email

-

Subscribe here

-
- - - - - - - - - - - - -
- - -
- - - - - diff --git a/public/post/eslint/index.html b/public/post/eslint/index.html deleted file mode 100644 index a5579e1..0000000 --- a/public/post/eslint/index.html +++ /dev/null @@ -1,371 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Technical Writer @ESLint - TWR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- TWR - -
- - - - - -
- - - - - - - - -
-
- - -
- - -
-
-

Technical Writer @ESLint

- - -
- - - - - · - Wisdom - -
- -
- -

Job Location: Remote

-

Level: Senior

-

ESLint is like spell check for code. Developers download ESLint more than 100M times each month to help find and fix problems in JavaScript and TypeScript code. Linters like ESLint give developers rapid feedback by pointing out problems interactively while editing code and automatically before changes are merged into projects. ESLint is used on more than 9M projects ranging from students learning to code to solo side projects to massive codebases at companies like Microsoft, Airbnb, Netflix, and Meta.

-

We recently launched the new eslint.org website. It is the result of several months of collaboration with a designer, a developer, an artist, and an animator.

-

Now that we have a nice place to host our documentation, we are turning our attention to the actual content. Customizability is one of ESLint’s core design principles, and that inherently requires more documentation. We’ve been adding onto the docs with each new feature since ESLint’s first release in 2013, and we don’t feel the current structure and content are suitable for the current state of the project.

-

The docs have three primary audiences:

-
    -
  • Users visit the configuration docs to learn how to set up and run ESLint for their project or make improvements to an existing project’s configuration.
    • -
  • Developers reference the API docs to build plugins, custom rules, parsers, shared configurations, and more that extend ESLint with new functionality.
    • -
  • Contributors reference the developer docs for insights into how the project is organized, how to submit pull requests, and to learn how to work within the ESLint codebase. -You Will
    • -
-

Understand what developers are seeking from ESLint’s documentation. -Learn what existing documentation is available and how it’s organized. -Develop a plan for reorganizing and rewriting the documentation to better meet audience needs. -Progressively reorganize, update, and improve the documentation based on the plan. -Throughout the project, iterate based on feedback from developers and maintainers. -About You

-

You have experience writing technical and API documentation for developers. -While not a requirement, it’s certainly a bonus if you are familiar with JavaScript and ESLint. -ESLint’s documentation is in English, but developers are all around the world. You have professional technical fluency in English and care about writing that is accessible to those less familiar with English. -You are comfortable writing in Markdown for formatting. -You are comfortable with or willing to learn Git and GitHub workflows for collaborative source control and code review. -The Role

-

This is a project-based contract. -While you will certainly be welcome to continue contributing after the contract is complete (and some of the folks who helped on the website redesign have), that is not an expectation. -You will have a primary contact on the core maintainer team.

-

Apply

-

Subscribe to my newsletter for more jobs and writing tips in your email

-

Subscribe here

-
- - - - - - - - - - - - - - -
- - -
- - - - - diff --git a/public/post/index.html b/public/post/index.html index be9edce..1891666 100644 --- a/public/post/index.html +++ b/public/post/index.html @@ -263,7 +263,17 @@
-

Introduction to Wed development

+

Introduction to doc as code

+ + +
+ + + + + +
+

Introduction to Web development

@@ -272,6 +282,16 @@

Introduction to Wed development

+
+

Subject Matter Expert

+ + +
+ + + + +

Introduction to KnowledgeBase

@@ -311,12 +331,55 @@

Git Essential Training - The Basics

- + +
+

Introduction to Command Line Interface

+ + +
+ + + + + +
+

Information Architecture and Topic-based writing

+ + +
+ + + + + +
+

Introduction To Technical Writer

+ + +
+ + + + + +
+

Use Of English

+ + +
+ + + + + +
+

Great Documentation

+ + +
+ + + diff --git a/public/post/index.xml b/public/post/index.xml index 1304ef1..f646dfd 100644 --- a/public/post/index.xml +++ b/public/post/index.xml @@ -7,9 +7,19 @@ Hugo -- gohugo.io en-us Copyright © 2022, Wisdom Nwokocha all rights reserved. - Sat, 22 Oct 2022 00:00:00 +0000 + Wed, 02 Nov 2022 00:00:00 +0000 - Introduction to Wed development + Introduction to doc as code + https://technicalwriterresources.pages.dev/post/introduction-to-doc-as-code/ + Wed, 02 Nov 2022 00:00:00 +0000 + + https://technicalwriterresources.pages.dev/post/introduction-to-doc-as-code/ + Writing, revising, and publishing procedures can be made more efficient using the documentation technique and practice known as &ldquo;docs as code.&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. + + + + Introduction to Web development https://technicalwriterresources.pages.dev/post/introduction-to-web-development/ Sat, 22 Oct 2022 00:00:00 +0000 @@ -18,13 +28,22 @@ You can read through the complete beginner guide to web development on MDN + + Subject Matter Expert + https://technicalwriterresources.pages.dev/post/subjectmatterexpert/ + Fri, 14 Oct 2022 00:00:00 +0000 + + https://technicalwriterresources.pages.dev/post/subjectmatterexpert/ + 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 + + Introduction to KnowledgeBase https://technicalwriterresources.pages.dev/post/introduction-to-knowledgebase/ Sun, 09 Oct 2022 00:00:00 +0000 https://technicalwriterresources.pages.dev/post/introduction-to-knowledgebase/ - Agenda This deck covers the following topics: + 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 diff --git a/public/post/umee/index.html b/public/post/introduction-to-doc-as-code/index.html similarity index 53% rename from public/post/umee/index.html rename to public/post/introduction-to-doc-as-code/index.html index 703f952..2fc1ba3 100644 --- a/public/post/umee/index.html +++ b/public/post/introduction-to-doc-as-code/index.html @@ -35,15 +35,13 @@ - Technical Writer @Umee - TWR + Introduction to doc as code - TWR - + @@ -102,24 +100,24 @@ - - + + - - - + + + - - - - - + + + + + - - + + @@ -258,12 +256,12 @@
-

Technical Writer @Umee

+

Introduction to doc as code

- + · @@ -273,72 +271,50 @@

Technical Writer @Umee

-

Job Location: Remote

-

Level: Senior

-

We’re looking for a candidate who thrives in a fast-paced, diverse environment. The Technical Writer will act as the bridge between our core dev team and the open source dev community. You are expected to produce top quality technical documentation.

-

Umee is laser-focused on building and delivering our products and core mission. We take our work extremely seriously and we want to hire top notch executors to make things happen and put all the pieces together. Passion for the crypto industry and prior crypto experience is a must. We only want to work with people who are willing to learn fast, work hard and not compromise on the quality of work.

-

Responsibilities:

+

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

    -
  • Write, edit, and review all developer-focused technical documentation, written in a mix of markdown & JSON
    • -
  • Test the products and documentation to ensure accuracy and consistency
    • -
  • Partner with Engineering, Product and Support to build and improve our documentation
    • +
  • Writing format
    • +
  • Static site generator
    • +
  • Version control system
    • +
  • Continuous integration
    • +
  • Collaborating with other writers using version control
    • +
  • Running validation checks
-

Requirements:

+

The advantages of using a docs-as-code approach?

  • -

    Deep knowledge of Cosmos and the broader cross chain ecosystems

    +

    Developer doc contribution: It’s easier for developers to contribute to the docs themselves. 

  • -

    2+ years experience in developer relations, developer support, and/or writing documentation for Web3 projects

    -
    • -
  • -

    Developer background

    -
    • -
  • -

    Experience with JS/TS and subgraph is a plus

    -
    • -
  • -

    Experience in fast paced start-up environments

    +

    Collaboration: Using the same tools and procedures facilitates collaboration between authors, developers, and users.

-

Benefits:

+

How to set up docs as code

+

In this example, you will use docusaurus to create your documentation site.

+

Prerequisite

    -
  • 100% remote work
    • -
  • Work with a top performing team
    • -
  • Competitive salary
    • -
  • Be a part of something great
    • -
  • Fun and impactful role
    • +
  • Install Vscode
    • +
  • Install Nodejs
-

How to Apply:

-

To apply, please email hr@umee.cc and include a resume with a link to your github account.

-

Subscribe to my newsletter for more jobs and writing tips in your email

-

Subscribe here

-
+

Install docusaurus

+

The easiest way to install Docusaurus is to use the command line tool that helps you scaffold a skeleton Docusaurus website.

+
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

+
cd my-website
+

Run the preview mode with the command below.

+
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:

+
npm run build
+
- - @@ -348,8 +324,8 @@

How to Apply:

Technical Writer @ESLint→Introduction to Web development → diff --git a/public/post/introduction-to-knowledgebase/index.html b/public/post/introduction-to-knowledgebase/index.html index e54ab7e..d0151b3 100644 --- a/public/post/introduction-to-knowledgebase/index.html +++ b/public/post/introduction-to-knowledgebase/index.html @@ -40,7 +40,7 @@ - @@ -271,7 +271,12 @@

Introduction to KnowledgeBase

-

Agenda

+
+
+ +
+ +

Agenda

This deck covers the following topics:

  • User Guides
    • @@ -306,8 +311,8 @@

    Case Study- Stripe-