• Stars
    star
    479
  • Rank 88,640 (Top 2 %)
  • Language
  • License
    MIT License
  • Created about 4 years ago
  • Updated 7 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

πŸ¦„ A sample template with guidelines for writing technical articles.

technical-writing-template

A sample template for writing a technical article πŸ¦„

πŸ‘‰ View the template πŸ‘ˆ

Template Headings

## Title

## Introduction

## Prerequisites

## Headings

## Conclusion

## Attributions

Title

As the name implies, this is the title of your article which describes what your article entails. Ensure to use title case here.

  • What will a reader accomplish after reading your article?
  • Include the goal of the article in the title.
  • (Optional) Include the tool(s) the reader will use to accomplish that goal.

Here are some examples:

  • Accessibility Auditing with Axe for Automated Web UI Testing
  • How to Deploy a Node Application and Database to Heroku
  • Handling Static Forms, The Client-side Way
  • Understanding Recursion in JavaScript
  • Getting Started with Nodejs - An Overview and Walkthrough Tutorial

Introduction

This is the first section of your article that introduces your reader to your article and the goals they will accomplish after reading. This section ought to motivate the reader, summarize; what the article is about, why the reader should read, and what the reader will learn/ do in the article. Ensure to make this one to three paragraphs long.

Here is an example from my previous article (Image Optimization and Transformation with Cloudinary):

image

Prerequisites

In this section, you are to list out all the things your reader should do or have before reading your article as bullets or checklists. This is always useful to ensure your reader(s) can follow along without missing out at any section of the article. Please note that this should not be only practised with articles that entail some installation setup but any kind of article. It can just be as minimal as asking your reader(s) to grab cold water before reading the article. A great way to get them ready, yeah?

Here is an example from my previous article (Building a SlackBot with Node.js and SlackBots.js):

image

Headings

In this section, you are to break your article into parts and list them out as headings. This will allow you to write in a more organized manner and enable your reader(s) to read in an orderly manner. Ensure to make these headings an <h2> element.

Here is an example from my previous article (Accessibility Auditing with Axe for automated Web UI testing):

  • Introduction
  • What is Auditing?
  • Why Audit?
  • Introduction to Axe Library
  • Getting Started with Axe for Browsers
  • Getting Started with Axe for Android
  • Getting Started with Axe for CLI
  • Getting Started with Axe for React.js
  • Getting Started with Axe for Vue.js
  • Bonus: Linting with eslint-plugin-jsx-a11y
  • Conclusion

Conclusion

Here you should summarize your article just as similar to the introduction with a final closing note and maybe links for further research or study.

Here is an example from my previous article (How to Ask Effective Questions: A Practical Guide for Developers):

image

Attributions

Here ensure you add credits to resources, extracts, quotes, images or any other content of which you are not the creator.

Here is an example from my previous article (Getting Started with Hugo and Deploying to Netlify):

image

More Repositories

1

awesome-technical-writing

πŸ“š A curated list of awesome resources: articles, books, videos, tools, podcasts about technical writing.
1,613
star
2

awesome-jamstack

πŸ“” Curated list of resources: books, videos, articles, speaker decks, tools about using the Jamstack.
146
star
3

js-code-snippets

Learn basic JavaScript concepts in action. ⚑
JavaScript
80
star
4

netty-finder

☎️ This script checks a Nigerian telephone number and detects which network it belongs to.
JavaScript
50
star
5

inspireNuggets

🌻 inspireNuggets is a Chrome Browser (Web) Extension that displays random inspiring techie quotes for developers/designers.
CSS
39
star
6

OOP-JavaScript

Learn OOP JavaScript ⚑
JavaScript
36
star
7

altschool-profile-template

The official README profile template for AltSchool Africa students.
35
star
8

inspireNuggetsSlackBot

A simple Slackbot that displays random inspiring techie quotes and jokes for developers/designers.
JavaScript
16
star
9

image-search-app

A simple image search app
JavaScript
16
star
10

bolajiayodeji.com

πŸ’™ My personal website (WIP).
TypeScript
16
star
11

BolajiAyodeji

My automated GitHub README Profile built using Nodejs, TypeScript, and GitHub Actions.
TypeScript
16
star
12

simple-ajax-library

A simple AJAX Library for making HTTP Requests
JavaScript
16
star
13

simple-fetch-library

A simple Fetch API library for making HTTP Requests
JavaScript
14
star
14

hugo101

Getting started with Hugo and Deploy to Netlify ⚑
HTML
11
star
15

bolajiayodeji.github.io

πŸ¦„
11
star
16

deploy-ml-web-workshop

In this workshop, you will learn how to build a machine learning model using Python/Scikit-Learn, turn the model into an API using Python/Flask, test the API, build web applications using HTML/CSS/JavaScript/Nextjs, and deploy it to the web for global usage by end-users.
Jupyter Notebook
11
star
17

dotfiles

My dotfiles, aliases, configurations, and general workspace setup.
Shell
10
star
18

nextjs-blog

Simple Nextjs Blog
JavaScript
10
star
19

weight-converter

Simple weight converter πŸ’ͺ
HTML
10
star
20

speech-to-text

Simple speech to text app built with React and IBM Watson.
JavaScript
9
star
21

cl-jamstack-ecommerce-workshop

Build headless commerce web experiences with Jamstack and Commerce Layer.
8
star
22

async-js

Learn Asynchronous JavaScript ⚑
JavaScript
8
star
23

cl-composable-commerce-workshop

In this workshop, you will learn how to build a completely static ecommerce solution with Commerce Layer, Demo Stores, and some other dev tools.
8
star
24

face-detector

A PERN stack face detector app
JavaScript
7
star
25

learning-node

Learning NodeJS + ExpressJS πŸ¦„
JavaScript
6
star
26

conf-swag-demo-store

An ecommerce website built using the Commerce Layer Demo Store project.
JavaScript
6
star
27

sensy-words-filter

Package for filtering out a list of sensitive words
JavaScript
6
star
28

chat-with-siri

πŸ€– A text-to-speech chatbot built using Nextjs, OpenAI, and ElevenLabs.
TypeScript
5
star
29

vue-boilerplate

PWA vue development boilerplate setup with CLI3
Vue
5
star
30

sanity-commercelayer-demo

Commerce Layer Starter Demo
TypeScript
5
star
31

naira-converter

A simple PWA currency to Naira converter :octocat:
JavaScript
4
star
32

OOP-Book-Store

A simple book store built with JavaScript ⚑
JavaScript
4
star
33

react-google-map

Display Google Maps in React App with Google Maps API
JavaScript
4
star
34

nodejs-web-scraper

Web Scraping with Nodejs
JavaScript
4
star
35

Blogposts

Auto content backup from my personal blog.
4
star
36

qrcode-builder

PWA QR Code Generator
HTML
4
star
37

rentify-frontend

Rentify is a virtual renting platform that allows you to rent your electronics and book rentals.
HTML
4
star
38

github-users-finder

A simple GitHub users finder app
JavaScript
4
star
39

robo-friends

My first React App βš›οΈ (A simple robots directory)
JavaScript
3
star
40

fed-unis-perf-eval

Research: Accessibility And Performance Evaluation Of Federal University Websites In Nigeria.
HTML
3
star
41

weather-app

A simple weather app built with JavaScript
JavaScript
3
star
42

code-lab-demo

Template project for my PWA code-lab
HTML
3
star
43

dom-tutorial-notes

Useful JavaScript DOM concepts :octocat:
HTML
3
star
44

movie_reviews_sentiment_analysis

A ML model that will predict whether a movie review is positive or negative.
Jupyter Notebook
3
star
45

day-of-birth-finder

This script checks your Date of Birth and detects the Day of the Week you were born.
HTML
3
star
46

twitter-bot

My personal twitter bot 🐦
JavaScript
2
star
47

face-detector-api

API for the face detector app
JavaScript
2
star
48

react-todo

WIP: A simple todo list app
JavaScript
2
star
49

bootstrap-starter-template

Basic Bootstrap Starter Template
HTML
2
star
50

Tech-Geeks-Hub

Community for Tech Geeks!
Hack
2
star
51

hugo-boilerplate

A Hugo boilerplate for creating truly epic websites
JavaScript
2
star
52

reusable-ui-demo

TypeScript
2
star
53

Thumbnail-Gallery-Template

Simple Bootstrap Thumbnail Gallery template | Grids
HTML
2
star
54

contentful-boilerplate

Boilerplate project for getting started using JavaScript with Contentful CMS
JavaScript
2
star
55

learnRegExp

Learning error handling in JavaScript with Regular Expressions
JavaScript
2
star
56

credit_card_fraud_detection

A basic machine learning model that will detect potential fraud cases from transactions so that customers won’t be charged for the items they did not purchase.
Jupyter Notebook
2
star
57

cl-twilio-webhooks-demo

A minimal demo for sending an SMS notification to customers when an SKU that had finished is back in stock using Commerce Layer Webhooks and Twilio SMS.
JavaScript
2
star
58

standard-inputs

My first ruby script
Ruby
2
star
59

iris_visualization

Some data visualization techniques practice on the Iris dataset with R.
HTML
2
star
60

hh-store

Demo of a fully functional e-commerce store and blog for my "Integrating Hashnode Headless CMS with Ecommerce Platforms" tutorial.
TypeScript
1
star
61

elevenlabs-api-sandbox

Quick test of ElevenLabs API and client libraries.
Python
1
star
62

one-click-hugo-cms

CSS
1
star
63

jekyll-blog

Simple Jekyll Blog
HTML
1
star
64

Resume-Project

Resume
HTML
1
star
65

devSquareNewsletter

Devcenter Square SendGrid Newsletter Form
CSS
1
star
66

Login-Signup-Page1

Simple User page for Signup, Login & forgot password.
CSS
1
star
67

mortgage-calculator

simple mortgage-calculator
HTML
1
star
68

Basic-Prototype

#iHackAfrica2018 Hackathon
CSS
1
star
69

open-sauced-goals

1
star
70

Hello-world

My first respository on github
HTML
1
star
71

cl-sendgrid-webhooks

Sample code and templates for sending emails to customers using Commerce Layer Webhooks, Zapier Code Runner, Nodejs, and SendGrid API.
HTML
1
star
72

emperorphotoshop

Homepage for Emperor Photo Shop
JavaScript
1
star
73

Extinct-Portfolio

My personal portfolio website
JavaScript
1
star
74

scrimba-react

JavaScript
1
star
75

Mock-Design-Project

Mock Design
JavaScript
1
star
76

Techne-Republic

Website for TechneRepublic
CSS
1
star
77

iOS-Calculator

PWA Calculator with iOS user interface for Web, Android & iOS.
JavaScript
1
star
78

JS-Guessing-Game

Simple guessing game built with Javascript
JavaScript
1
star
79

OLD-portfolio-website

My personal portfolio website
HTML
1
star
80

linear-regression

Linear regression attempts to model the relationship between two variables by fitting a linear equation to observed data.
R
1
star
81

Animated-Menu-Icon

Simple Menu Icon Animation
HTML
1
star
82

diabetes-prediction

HTML
1
star
83

TodoList-App-Mavo

To-Do List App Built with MAVO, HTML5 and CSS3
CSS
1
star
84

inspire-nuggets-web

Simple Quote Generator for Techies
JavaScript
1
star
85

pay-with-tweet

Commerce Layer Pay With Tweet external payment gateway.
TypeScript
1
star
86

dashmon-react-test

Code Test for Front-end Developer Role @ Dashmon
HTML
1
star
87

loan-calc

Simple loan calculator :octocat:
JavaScript
1
star
88

discord-bot

In progress...
TypeScript
1
star
89

Multiple-Slideshow

# Multiple Slideshow HTML5 | CSS3 | JS
JavaScript
1
star
90

BuyCoins-coding-challenge

Coding Challenge
HTML
1
star
91

bar-bouncer

This app checks if a customer is eligible to enter a bar and buy an alcohol.
HTML
1
star
92

task-manager

Simple Task Manager :octocat:
JavaScript
1
star
93

start-jekyll

Simple Jekyll Static Blog
Ruby
1
star
94

vue-socks-shop

A simple Vue socks e-Shop ⚑
JavaScript
1
star
95

JavaScript30-Projects

A Directory of all Projects built during WesBos #JavaScript30 Course
HTML
1
star
96

randomUsers

Implementation of How to Use the JavaScript Fetch API to Get Data
JavaScript
1
star
97

es6-modules-babel

JavaScript
1
star
98

brain-gym

Simple number guessing game :octocat:
JavaScript
1
star
99

bookmarker

Bookmark your favorites sites :octocat:
JavaScript
1
star
100

contacts-filter

Simple list filter :octocat:
JavaScript
1
star