Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AJK Town Doc Standard #100

Open
mlajkim opened this issue Apr 14, 2024 · 0 comments
Open

AJK Town Doc Standard #100

mlajkim opened this issue Apr 14, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mlajkim
Copy link
Contributor

mlajkim commented Apr 14, 2024

Background

Great documentation follows great rules like Google: https://developers.google.com/tech-writing/one/documents#define_your_audiences_needs
Every document should follow the following format:

# <title-of-your-document>
<less than 3 sentences summary>

## TOC
<auto-generated-toc>

## What you will learn
<tell readers what they will learn>

## Prerequisite knowledge
<tell readers what knowledges are required before reading this>

TODOs

- [ ] Format all documentations with this format
- [ ] You do not have to write every content. Write TODOs first, and fix it later.
@mlajkim mlajkim added the documentation Improvements or additions to documentation label Apr 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant