deven-documentation-skeleton is built to work with NodeJS. It clones the deven's documentation skeleton in your project, provides information about the documentation coverage and help to you identify and clone the missing chapters.

• Deven Documentation Skeleton
  • ℹ️ Table of contents
• ⭐ Introduction
  • Goals
  • 📁 Documentation Structure
  • Requirements
  • Installation
  • 🚀 How to use it
    • 1. Install
    • 2. Check
    • 3. Update
• ✅ How to test
• ✌️ Contribute
• 🐛 Bugs and Issues
• 📄 License
• 💚 Code of conduct

Various projects at Song do not have a full or even partial documentation in the repositories to onboard new team members or give an overview of how to run the application or how it works. Reasons for this problem are not enough time or the missing knowledge of how a documentation contains to be of service.

The purpose of this "documentation skeleton" project is to provide a simple way to add a documentation to your project by providing a documentation skeleton including examples and an easy-to-follow structure.

• Enable engineers to add a full documentation with the least amount of effort to save time and money.
• Lessen the mental workload for engineers, as they will know in every project that uses the unified documentation project where to find the information they are looking for.
• Onboard new members faster on the projects.
• Keep information out of silos. Keep information preserved after people leave the project.

.
└── src/doc
    └── README.md
    └── ARCHITECTURE.md
    └── CODEOFCONDUCT.md
    └── CONTRIBUTE.md
    └── DEPLOYMENT.md
    └── GETSTARTED.md
    └── GLOSSARY.md
    └── PROJECTBACKGROUND.md
    └── TESTING.md

1. This setup is working for all operating system, testing on Windows 8, Windows 8.1, Windows 10, Mac and Linux. This project is a Node.js package. You need Node Version 4 or higher and npm Version 2 or higher, check your installed version with node -v and npm -v.

2. To run our code you have to meet the following requirements:

• Node.js => v14.0.0
  (for more information check out the Node.js Documentation)

• If you use Yarn, then => v1.2.0

• If you use Npm, then => v8.0.0

Install the package in your project:

npm install deven-documentation-skeleton --save-dev

or

yarn add deven-documentation-skeleton --dev

Add the following entries to your package.json scripts section:

   "scripts": {
      "doc:install": "deven-documentation-skeleton install",
      "doc:check": "deven-documentation-skeleton check",
      "doc:update": "deven-documentation-skeleton update"
   }

Install the documentation using the command install command.

npm run doc:install

or

yarn doc:install

Once the documentation skeleton has been installed, you can use the check command to verify the status of the documentation.

npm run doc:check

or

yarn doc:check

In case one or more chapters are missing in the local documentation folder, the command update will clone them into the doc folder.

npm run doc:update

or

yarn doc:update

Read more

Read more

If you would like to open an issue, you can gladly use this page. But please, have a look at the Contribute page before filing a bug.

MIT LICENCE

You can find the Code of Conduct here