showdoc 온라인 문서 공유 도구 v3.2.6

기타 카테고리

3.2.6

다운로드

ShowDoc은 IT 팀에 매우 적합한 온라인 API 문서 및 기술 문서 도구입니다. showdoc을 통해 마크다운 구문을 쉽게 사용하여 아름다운 API 문서, 데이터 사전 문서, 기술 문서, 온라인 Excel 문서 등을 작성할 수 있습니다. 마크다운 문서를 편집하고 싶지 않은 경우 showdoc의 자동화 기능을 사용하여 프로그램 주석에서 API 문서를 자동으로 생성하거나 일치하는 RunApi 클라이언트(postman과 유사한 API 디버깅 도구)에서 인터페이스를 디버깅하는 동안 자동으로 문서를 생성할 수도 있습니다. 프로젝트 구성원과 팀 구성원을 지정하여 프로젝트 문서 권한 및 팀 협업을 쉽게 관리할 수 있으며, 친구들과 문서를 공유하여 볼 수도 있습니다. ShowDoc은 또한 Win 클라이언트, Mac 클라이언트, iOS, Android 등을 포함한 다중 플랫폼 클라이언트를 지원하므로 크로스 플랫폼 사용이 더욱 편리해집니다. 현재 Tencent, Huawei, Baidu, JD.com, ByteDance, SF Express 등과 같은 유명 기업의 일부 팀을 포함하여 100,000개 이상의 인터넷 팀이 showdoc을 사용하고 있습니다.

그것은 무엇을 위해 사용될 수 있습니까?

1. API 문서

모바일 인터넷의 발달로 BaaS(Backend as a Service)가 점점 대중화되고 있습니다. 서버는 API를 제공하며, APP나 웹 프론트엔드에서 쉽게 데이터를 호출할 수 있습니다. ShowDoc을 사용하면 아름다운 API 문서를 매우 편리하고 빠르게 작성할 수 있습니다.

2. 데이터 사전

좋은 데이터 사전은 각 필드의 정의 등 데이터베이스 구조를 다른 사람에게 쉽게 설명할 수 있습니다.

3. 문서화

showdoc를 사용하여 일부 도구에 대한 지침을 작성할 수 있으며 팀이 검토할 일부 기술 사양 문서를 작성할 수도 있습니다.

어떤 기능이 있나요?

1. 공유 및 내보내기

반응형 웹 디자인, 프로젝트 문서를 컴퓨터나 모바일 장치로 공유하여 볼 수 있습니다. 동시에 오프라인 탐색을 위해 프로젝트를 단어 파일로 내보낼 수도 있습니다.

2. 권한 관리

(1) 공공사업과 민간사업

ShowDoc에는 공개 프로젝트와 비공개 프로젝트라는 두 가지 유형의 프로젝트가 있습니다. 공개 프로젝트는 로그인한 사용자나 로그인하지 않은 사용자라면 누구나 접근할 수 있으며, 비공개 프로젝트의 경우 접근 인증을 위해 비밀번호가 필요합니다. 비밀번호는 프로젝트 작성자가 설정합니다.

(2) 프로젝트 이전

프로젝트 작성자는 사이트의 다른 사용자에게 프로젝트를 자유롭게 전송할 수 있습니다.

(3) 프로젝트 멤버

ShowDoc 프로젝트에 프로젝트 멤버를 쉽게 추가하고 삭제할 수 있습니다. 프로젝트 구성원은 프로젝트를 편집할 수 있지만 프로젝트를 전송하거나 삭제할 수는 없습니다. (프로젝트 작성자만 권한이 있습니다.)

(4), 팀 관리

showdoc의 팀 기능을 사용하여 팀과 더 효과적으로 협업할 수 있습니다.

3. 편집 기능

(1) 마크다운 편집

ShowDoc은 탁월한 편집 및 읽기 경험을 제공하는 마크다운 편집기를 사용합니다. 마크다운을 모르신다면 검색엔진에서 "마크다운 이해 및 시작하기"를 검색해 보세요

(2) 템플릿 삽입

ShowDoc 편집 페이지에서 편집기 위의 버튼을 클릭하면 API 인터페이스 템플릿과 데이터 사전 템플릿을 쉽게 삽입할 수 있습니다. 템플릿을 삽입한 후 남은 것은 데이터를 변경하는 것뿐이므로 많은 편집 노력이 절약됩니다.

(3), 역사