showdoc online document sharing tool v3.2.6

ShowDoc is an online API documentation and technical documentation tool that is very suitable for IT teams. Through showdoc, you can easily use markdown syntax to write beautiful API documents, data dictionary documents, technical documents, online excel documents, etc. If you don’t want to edit markdown documents, you can also use showdoc’s automation capabilities to automatically generate API documents from program comments, or automatically generate documents while debugging the interface from the matching RunApi client (an API debugging tool similar to postman). By assigning project members and team members, you can easily manage project document permissions and team collaboration, and you can also share documents with friends for viewing. ShowDoc also supports multi-platform clients, including win client, mac client, ios, android, etc., making it more convenient for cross-platform use. Currently, more than 100,000+ Internet teams are using showdoc, including some teams within well-known companies, such as Tencent, Huawei, Baidu, JD.com, ByteDance, SF Express, etc.

what it can be used for

1. API documentation

With the development of mobile Internet, BaaS (backend as a service) is becoming more and more popular. The server provides an API, and the APP or web front-end can easily call data. ShowDoc can be used to write beautiful API documents very conveniently and quickly.

2. Data dictionary

A good data dictionary can easily explain your database structure to others, such as the definition of each field, etc.

3. Documentation

You can use showdoc to write instructions for some tools, and you can also write some technical specification documents for the team to review.

What functions does it have

1. Share and export

Responsive web design, project documents can be shared to computers or mobile devices for viewing. At the same time, you can also export the project into a word file for offline browsing.

2. Permission management

(1), public projects and private projects

There are two types of projects on ShowDoc: public projects and private projects. Public projects can be accessed by any logged-in or non-logged-in user, while private projects require a password to authenticate access. The password is set by the project creator.

(2) Project transfer

Project creators are free to transfer projects to other users of the site.

(3), project members

You can easily add and delete project members to ShowDoc projects. Project members can edit the project, but cannot transfer or delete the project (only the project creator has permission)

(4), team management

You can better collaborate with your team using showdoc's team function

3. Editing function

(1), markdown editing

ShowDoc uses markdown editor, which provides excellent editing and reading experience. If you don’t know Markdown, please search for “Understanding and Getting Started with Markdown” in the search engine

(2) Template insertion

On the ShowDoc editing page, click the button above the editor to easily insert API interface templates and data dictionary templates. After inserting the template, all that's left is to change the data, saving a lot of editing effort.

(3), history

ShowDoc provides a history function for the page, and you can easily restore the page to the previous one.

4. Multi-platform

showdoc supports mobile app version and computer client version.

5. Automation

(1) Documents can be automatically generated from code comments

(2), equipped with RunApi client, debugging interface and automatically generating documents