AJK Town Documentation

• AJK Town Documentation
  • Overview
  • For technical writers of AJK Town Docs
  • For documentation
    • About folder structure for this documentation
    • About the style guide of the documentation
    • dev
    • install

Overview

Documentation for AJK Town application including how to develop, install, and use it.

For technical writers of AJK Town Docs

Just like a great engineer, it takes years of focused practice to become a great technical writer¹. AJK Town first recommends to read the following resources and then read/write documentation of AJK Town.

• Google's free technical writing courses
  • https://developers.google.com/tech-writing/overview

For documentation

About folder structure for this documentation

We follow the same folder structure as the GitLab

About the style guide of the documentation

We follow Google developer documentation style guide

dev

• how to develop AJK Town application or its related ones

install

• how to install AJK Town application or its related ones

Footnotes

1. https://developers.google.com/tech-writing/one#learning_objectives ↩