https://github.com/dctacademy/docs-format
This repository provides best practices for writing documentation and basic folder structure that has to be followed while writing Node app (or any app in general)
https://github.com/dctacademy/docs-format
docs documentation node-js readme readme-template
Last synced: 12 months ago
JSON representation
This repository provides best practices for writing documentation and basic folder structure that has to be followed while writing Node app (or any app in general)
- Host: GitHub
- URL: https://github.com/dctacademy/docs-format
- Owner: dctacademy
- License: mit
- Created: 2018-09-26T11:04:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-03T09:30:34.000Z (almost 7 years ago)
- Last Synced: 2024-11-20T22:52:32.567Z (over 1 year ago)
- Topics: docs, documentation, node-js, readme, readme-template
- Size: 29.3 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DCT Academy's Documentation Format
This repository provides best practices for writing documentation and basic folder structure that has to be followed while writing Node app (or any app in general).
**Note:** You can use a tool like [README.md Genearator](https://github.com/kefranabg/readme-md-generator) to ease up your process.
In order to write documentation on GitHub, you have to first understand Markdown, a standard used by GitHub to accept documentation.
* Learn more about Markdown [here](https://en.wikipedia.org/wiki/Markdown)
* Learn how to use Markdown [here](https://www.markdowntutorial.com/)
* Find Markdown cheatsheet [here](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
Examples of a good documentation:
* [Node.js](https://github.com/nodejs/node) GitHub repository
* [React.js](https://github.com/facebook/react) GitHub repository
* [Bootstrap](https://github.com/twbs/bootstrap) GitHub repository
> Do not include the above paragraph in your documentation.
---
# Project Title
Write your project overview here. A short description about your project and what it does. It should also provide details, links, algorithms or other resources like tutorials, links to articles and research papers, used in the application.
One to two paragraph statement about your product and what it does. Add a screenshot (user logged in) as shown below.
# Installation/Development
Imagine a new developer who wants to use/run your project. It's a good practice to write all the tools, dependencies and versions of packages that you have used in your app. You can exclude trivial dependencies and only include that you have used specific to this project. There are chances that the developer might be using a different operating system or an environment.
Operating System 1:
```
npm install
```
Operating System 2:
```
npm install
```
Describe how to install all development dependencies and how to run an automated suite. Potentially do this for multiple platforms
* Packages 1/Dependencies 1
* Packages 2/Dependencies 2
* Packages 3/Dependencies 3
* .
* .
* Packages N/Dependencies N
# Usage
Write a brief description on how to use your project/app. Write about the features involved, different ways of using your app. Explain like you are explaining this to your customer or client. Use bullet points if necessary.
[Demo](https://.com)
Post a demo link along with demo login credentials if your app is successfully deployed.
# Credits
Give out credits to all the people who have helped you in building this application.
* [Link to Person 1's profile](https:///), This Position at That Company
* [Link to Person 2's profile](https:///), This Position at That Company
* [Link to Person N's profile](https:///), This Position at That Company
# License
Copyright(c) {year of production}, [Link to your company/organisation](https://www.yourorg.com)
Add a few lines about who can use your open-source project, its liabilites and legal content (if necessary). Use can use either an [MIT License](https://opensource.org/licenses/MIT) or an [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0) for the same. (A sample of MIT License is provided in the template code of this repository)
Learn more about open-source licenses [here](https://help.github.com/articles/licensing-a-repository/)
# Authors
List of Authors, Developers and Designers of this app are listed here including yourself.
* [Link to Author 1's profile](https:///), This Position at That Company
* [Link to Author 2's profile](https:///), This Position at That Company
* [Link to Author N's profile](https:///), This Position at That Company