Documentation Competition Template

View the full template with commented instructions on GitHub

Title of Creator Made Documentation

Richard Lee (Shards632)
August 17, 2025

Introduction

Writing documentation that is clear and concise is not a simple task. This document will attempt to provide you with an outline that you can follow to organize your writing into a way that people can quickly and easily access the information you’re providing.

Prerequisites and Expectations

You will need a GitHub account to contribute documentation, and you should be familiar with using GitHub Markdown for formatting. Also, it’s presumed that as a prerequisite, you have some knowledge about the topic you are about to write a document on.

Document Organization

This document has two parts, that discuss how you would talk about two topics. Additionally there is a reference section at the end. For such a simple document, you probably don’t need this section.

• Topic One
• Topic Two
• References

Topic One

This is where we discuss the first interesting topic of this document.

Lists

There might be lists

Unordered

• some
  • unordered
  • nested
    • lists
• of
• data

Ordered

1. some
   1. ordered
   2. nested
      1. lists
2. of
3. data

Code

You will likely want to reference code:

function myFancyFunction(value: number) {
  console.log(`You chose ${value}!`);
}

Images

It might have some images:

Topic Two

This is where we discuss the second interesting topic of this document.

Tables

An advanced formatting option is tables

Diagrams

Diagrams are a very advanced markdown topic (and may not render correctly in non GitHub previews)

graph TD;
    A[Get Idea]-->B;
    B(Form Plan)-->C;
    C{?}-->D[Profit!];

References

• https://medium.com/shecodeafrica/a-guide-to-technical-writing-7efcd0e70166
  • an article on writing good technical documentation
• https://docs.google.com/presentation/d/14pFo4zP9LvEP5-bG9i-iwCVK0kyMZwrl5VuuxEwtHJI/edit?usp=sharing
  • slidedeck presentation of “Fast-track your Docs with GitHub Templates” Build Along Workshop