Internal Documentation Example

This is an example repo that can be copied into the /docs folder of your codebase. It follows the Diátaxis method of technical documentation management. Here are some useful sections to keep in the README of your project.

Introduction

An introduction to the area of the organization that this project lives in and the context around why this project was designed.

Getting Started

How to get this repo up and running.

I'm a developer working on this project, where do I start?

Instructions for a developer that may be making changes to this repository.

I'm a consumer of this project, where do I start?

Instructions for someone that may be using the production version of this project.

Internal Documentation Example

This is an example repo that can be copied into the /docs folder of your codebase. It follows the Diátaxis method of technical documentation management. Here are some useful sections to keep in the README of your project.

Introduction

An introduction to the area of the organization that this project lives in and the context around why this project was designed.

Getting Started

How to get this repo up and running.

I'm a developer working on this project, where do I start?

Instructions for a developer that may be making changes to this repository.

I'm a consumer of this project, where do I start?

Instructions for someone that may be using the production version of this project.