Docz - It's never been easier to document your things! Let's test this statement – 2022
Published: 2022-01-14 09:02:28

---
canonical_url: https://aviyel.com/post/1793/it-s-never-been-easier-to-document-your-things-let-s-test-this-statement-in-2022
---

Whether you are the founder of a start-up or multinational company, developer and project admin, you know what you all have in common?
Document, yes it is an important part of your product, without documenting the product is like selling a dress without a tag.

Imagine you go shopping and you like a dress but there is no tag on it, so you don't understand whether this dress is in your budget or not. 

Similarly if you launch a product or you develop an application for your startup or multinational company without great documentation your product or service will not be well-received and if you’re the only one who understands it if so, it doesn’t do any good. So Having the right documents can help keep your audience and users happy and satisfied.

In the software industry, technical documentation describes the various API routes and various steps a developer can take to get started with a project but creating a perfect document is also difficult and it also takes a long time. But we see how the technology is becoming more advanced day by day and by using the latest technology a developer has created **Docz - It's never been easier to document your things! open source software.**


## Docz
Creating documentation is not just writing about the product or project, it is much more than that. It should be easy to read, be SEO-friendly and precise.

### Introduction
[Docz](https://www.docz.site/) is an [Open-Source Software](https://github.com/doczjs/docz/) powered by Gatsby that helps in creating or maintaining documents and It has all above features to make the document perfect as per their official documentation claim.

It uses GatsbyJS and Gatsby theme shadowing to let you quickly develop live-reloading, SEO-friendly, production-ready documentation sites using MDX and adjust the look, feel, and behaviour as needed.


### Principle
After reading the [Docz](https://www.docz.site/) documentation thoroughly we can say that it is a really impressive application and creating documentation is now just a piece of cake. It is built on the most important principles of document creation, making it easy for users to create great quality documentation. Here are some key features mentioned which we’ll be testing in this article:

- Zero config and easy to learn: Avoid unnecessary build steps with confusing setups.
- Blazing fast: Built with performance in mind from the start.
- Easy to customize: Create something that will be easy to use and customize.
- MDX-based: Use the best standard for writing documentation.

The biggest example is their own documentation. You see how it was built, simple and easy to understand and its principles meet all the requirements to create a perfect document. But writing these principles into a document is not proof that it works that way. There are a lot of applications in the market which claim to do a bunch of things but fail to meet the requirements of the user.

Thus, before we start using this application, why not test this application and lay out the results so that it may be helpful to users in need of genuine documentation solutions.


### Testing

So as per the principles of Docz, it takes no time to learn, has zero configuration, is faster than any other application and makes the theme customizable to the user to design it as per their choice.

Let us understand all these statements one by one.

- Zero Configuration

Let's see how we add Docz to our project. So basically, we have to install NodeJS in our system and after installing NodeJS we have to create a folder for the project somewhere in our system and open the project folder in the terminal.

Now execute the command below in the terminal and be sure you are in the project directory.

`$ yarn create docz-app my-docz-app --example typescript`

💥 BOOM, You're... 

## For Full Article, visit [Aviyel](https://aviyel.com/post/1793/it-s-never-been-easier-to-document-your-things-let-s-test-this-statement-in-2022)