When you take over a module or project that was developed by someone else, reading code without any notes or comments can be painful.
Where is the documentation?! Show me the doc!
Programmers often expect others to write technical documentation, but rarely want to write it themselves. Writing good technical documentation takes a lot of time and effort, and involves a great deal of non-technical work, such as deciding on the format and layout, or figuring out which catalog a new Word document should be filed under.
In most teams, Word documents are maintained separately by different people.
How do you get the latest version of a document? Here is a common approach:
You ask around for it. If you're lucky, someone will send you a copy over IM or email. This works, but it is far from the most efficient way.
So, what is the most efficient way? ShowDoc!
ShowDoc is a tool designed for IT teams to share documents online. It improves communication efficiency among team members.
-
API Document (Demo)
With the growth of mobile Internet, BaaS (Backend as a Service) has become increasingly popular. The server-side (backend) provides APIs, and apps or web frontends can conveniently consume data through them. With ShowDoc, you can create elegant API documents quickly and easily.
-
Data Dictionary (Demo)
A well-structured data dictionary can clearly present your database schema and define the meaning of every field.
-
Explanation Document (Demo)
You can use ShowDoc to write tool instructions or technical specification documents for your team to reference.
-
Responsive web design lets your team read project documents on computers and mobile devices. You can also export a project as an offline Word document.
-
-
Public and Private Projects
Projects on ShowDoc fall into two categories: public and private. Public projects can be viewed by anyone; private projects require login. The password is set by the project owner.
-
Project Transfer
The project owner can freely transfer a project to someone else.
-
Project Members
You can easily add or remove project members. Members can edit documents, but only the owner can transfer or delete a project.
-
-
-
Markdown Support
ShowDoc uses a Markdown editor that is excellent for both writing and reading. If you are new to Markdown, search for "Markdown tutorial" to get started.
-
Template Insertion
On the editing page, a single click on the button at the top of the editor inserts an API interface template or a data dictionary template. After inserting a template, you only need to fill in the data, which saves a lot of editing work.
-
Version History
ShowDoc keeps a version history for every page, so you can easily restore a previous version.
-
-
ShowDoc Deployment
Please refer to: AutoInstall.md
-
Development & Contribution
Please refer to: Development&Contribution.md
ShowDoc is released under the Apache 2.0 Open Source License and is free to use.
In addition to the Apache 2.0 license, ShowDoc carries an extra copyright notice:
- ShowDoc official and the author star7th hold the copyright and corresponding rights to the program.
- Provided that the copyright information and links on the program UI are retained, the program may be used for free or further development.
- If you need to change the copyright information or links, you must obtain the official consent and authorization.