Writing documentation

Posted: September 06, 2022 - Updated: July 18, 2023

This document is just a roadmap for sample documentation taken from README-Template.md

Also resources:

See roadmap below ↓


Project name

Your project’s name is the first thing people will see upon scrolling down to your README, and is included upon creation of your README file.

One Paragraph of project description goes here

Demo

Link

Description

A description of your project follows. A good description is clear, short, and to the point. Describe the importance of your project, and what it does.

Table of Contents

Optionally, include a table of contents in order to allow other people to quickly navigate especially long or detailed READMEs.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Installation

Installation is the next section in an effective README. Tell other users how to install your project locally. Optionally, include a gif to make the process even more clear for other people.

A step by step series of examples that tell you how to get a development env running

Usage

The next section is usage, in which you instruct other people on how to use your project after they’ve installed it. This would also be a good place to include screenshots of your project in action.

Client-side

Client-side

Server-side

Server-side

Built With

These

Tests

Here

Contributing

Larger projects often have sections on contributing to their project, in which contribution instructions are outlined. Sometimes, this is a separate file. If you have specific contribution preferences, explain them so that other developers know how to best contribute to your work. To learn more about how to help others contribute, check out the guide for setting guidelines for repository contributors.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Getting help

email/chat/stackoverflow

Credits/Authors

Include a section for credits in order to highlight and link to the authors of your project.

License

Finally, include a section for the license of your project. For more information on choosing a license, check out GitHub’s licensing guide!

Acknowledgments

Hat tip to anyone whose code was used Inspiration etc

Comments