# 개발문서 퍼블리싱 시스템 - 프로젝트 비전 ###### tags: Kakao_Work_Bot_API_v1.0.0 ## 소개 우리는 기술플랫폼 회사로, 개발문서는 상품의 주요한 일부이다. 다양한 상품의 개발문서를 통합하여 독립된 웹 사이트로 제공하고자 한다. 사용자가 한 곳에서 원하는 정보를 찾을 수 있고, 문서를 항행하며 길을 잃지 않게 해야한다. 다양한 구성원이 참여하여 좋은 문서를 만들 수 있도록 문서 퍼블리싱 시스템을 구축하고자 한다. ### 목적 프로젝트의 비전을 논의함 ### 범위 개발문서를 작성/생성하는 방법, 게시하고 피드백을 받는 과정을 다룬다. 다양한 상품의 문서를 수집하고 분류하는 과정을 다룬다. 문서의 구체적인 내용을 다루지 않는다. ### 용어 * 개발문서 : 회사가 제공하는 소프트웨어, 모듈, API 서비스 등에 대해 이용방법, 빌드방법, 환경설정방법, API 참조 문서, 튜토리얼 등 * 개발문서 작성도구 : 개발자, 테크니컬라이터 등이 문서를 작성하는 데 사용하는 도구 * 개발문서 웹 사이트 : 개발문서가 게시되어 대중에게 공개되는 웹 사이트 * 개발문서 변환도구 : 개발문서 작성도구로 작성된 문서(블로그 글과 같은 포맷), 자동 생성된 문서(javadoc, jazzy, swagger 등으로 생성한 API 목록 포맷) 등 다양한 문서를 모으고 변환하는 도구 * 개발문서 퍼블리싱 시스템 : 위 작성도구, 변환도구, 웹 사이트 등을 포괄함 ## 포지셔닝 ### 비즈니스 기회 * (가칭)apibooks는 Kakao i Cloud, Kakao Work, Kakao i Engine, Kakao i Connect, Kakao i Insight 등의 상품에 대한 개발문서를 제공 * 타 개발자 사이트와 비교하여 차이점은 x, y, z이다. * 카카오개발자(https://developers.kakao.com)는 A이고, 이건 B이다. * 구글 클라우드 플랫폼, 네이버 개발자 센터, 카카오 개발자 등과 견주어서 차이점은... a, b, c이다. * 작게는 문서 잘 모아서 보여주는 것, 크게는 문서로 이 회사 먹여살려보겠어. (아무말대잔치) * 아직 사람들의 머리 속에 카카오 엔터프라이즈 API는 문서에 대한 선입견이 없다. 잘 되어있다고 기억되게 * 귀여운 개발문서 웹 사이트는 없다. 그리고 카카오니까 귀엽게? ### 문제점 * 개발문서 웹 사이트가 없다 (그래서 만든다) * 방문자 유입이 적을 것이다 - 상품도 신규라서... * 개발문서 읽다보면 방문자가 길을 잃는 경우가 있다 - IBM Cloud에서 사진 속 사물 인식하는 거 따라가고 있었는데 정신차리고 보니 음성 인식 부분을 보고 있더라... * API 버전별로 문서 구분이 안 되어있으면 보기 불편하고 헛된 정보를 보고 있게 된다 ### 상품 포지션 선언 * 고객(개발자)에게 카카오 엔터프라이즈의 상품을 알고 코드를 잘 볼 수 있는 곳, 작성자(내부 개발자와 테크니컬라이터)가 편하게 문서를 작성할 수 있는 곳 * (가칭)apibooks는 "개발문서 웹 사이트"로, 타 개발문서 웹 사이트보다 코드가 보기 좋고, 원하는 정보를 빨리 찾을 수 있는 특징을 갖는다. ## 이해관계자와 사용자에 대한 설명들 * 개발자 : 초안 작성. 쉽게 작성. 이용이 번거롭지 않아야함. * 테크니컬라이터 : 초안 문서 중간에 질문을 남기고 답을 받음. 개발자가 쓴 초안을 쉽게 수정 * 마케터 : 문서가 상품으로서 많이 소비될 수 있도록 촉진 * 프로젝트 매니저 : 적은 비용, 빠른 출시 * Champion : jean * Streering committee : brandon, jean #### 사용자 * 내부 : 개발자, 테크니컬라이터 * 외부 : 일반사용자, 개발자, 시스템 엔지니어 등 #### 사용자 환경 * 일반사용자 : 일반적인 업무 환경, 데스크탑 웹 * 개발자 : 데스크탑 웹, 모바일 웹 (대략 7:3 가정) * 업무 시간 중 사용 ## 상품의 개요 ### 상품 조망 * (작성자) - 작성도구 -> 변환도구 -> 웹 사이트 -> (사용자) * 도메인 네임 예시 : https://apibooks.kakao.ai/ * 첫 페이지에 상품별 큰 배너, 상품 선택하고 들어가면 좌측 메뉴에 문서 종류 * 문서 우측에 목차 ### 수용능력 웹 사이트 : 스태틱 웹 페이지 호스팅. 수만 방문자/일 작성도구 : 동시 수십명 ## 상품의 특징 1. 작성도구는 개발자와 테크니컬라이터가 동시에 수정 할 수 있다 2. 작성도구는 개발자와 테크니컬라이터가 문서에 코멘트로 질문답변 주고 받을 수 있다 3. 문서는 각 페이지마다 고유한 메타태그, og 태그를 가질 수 있다 4. 예뻐야하고 5. 문서를 쉽게 찾을 수 있어야하고 6. 검색 잘 되고 7. 검색 잘 되고 8. 이리 갔다 저리 갔다 하지 말아야하고 9. 상품 웹 사이트를 통해 유입되는 게 아니라, 문서를 보고 상품 웹 사이트로 가도록 한다 ### 그래서 뭘 만드는 거야? (성급한 대답) * 코드 indent, syntax highlight 되는 편집기 포함한 작성도구 * 자동 생성된 API 레퍼런스 문서 수집 자동화 * 이 문서들을 일관된 외양으로 표시할 CSS * 이 문서들을 html로 변환 자동화 * 메뉴 관리 (처음에 자동화 안 되면 일단 수동으로) * 이 문서들을 호스팅 ## 제약 8월 Kakao Work 오픈 시 문서를 출시하려면 작성도구는 7월 초에는 선정해야하고 변환도구랑 웹 사이트는 7월 말까지는 나와야 8월에 테스트하고 출시해야 함 ## 품질 범위 ## 선행과 우선순위 Kakao i Cloud 웹 사이트 화면설계 확인 -> https://zpl.io/bzEEGO4 Kakao i Cloud 문서 포함 Kakao Work 웹 사이트 화면설계 확인 -> 사용자가 어떻게 유입될 것인가? ### 성급한 결론 * 워드프레스 + WP Side Comments + Editor.md(markdown) + Code Prettify(syntax highlight) + WP2Static (Static Site Generator) * 각 페이지별 메타태그 관리 (SEO를 위해) * 방문자 코멘트는 disqus * ### 성급한 결론 2 * 6월 중 작성도구 서치 + 퍼블리싱 테스트 * 6월 중 문서 웹 사이트 화면설계 * 7월 초 퍼블리싱 개발 * 작성도구 선정과 함께 작성 시작 # Welcome to StackEdit! Hi! I'm your first Markdown file in **StackEdit**. If you want to learn about StackEdit, you can read me. If you want to play with Markdown, you can edit me. Once you have finished with me, you can create new files by opening the **file explorer** on the left corner of the navigation bar. # Files StackEdit stores your files in your browser, which means all your files are automatically saved locally and are accessible **offline!** ## Create files and folders The file explorer is accessible using the button in left corner of the navigation bar. You can create a new file by clicking the **New file** button in the file explorer. You can also create folders by clicking the **New folder** button. ## Switch to another file All your files and folders are presented as a tree in the file explorer. You can switch from one to another by clicking a file in the tree. ## Rename a file You can rename the current file by clicking the file name in the navigation bar or by clicking the **Rename** button in the file explorer. ## Delete a file You can delete the current file by clicking the **Remove** button in the file explorer. The file will be moved into the **Trash** folder and automatically deleted after 7 days of inactivity. ## Export a file You can export the current file by clicking **Export to disk** in the menu. You can choose to export the file as plain Markdown, as HTML using a Handlebars template or as a PDF. # Synchronization Synchronization is one of the biggest features of StackEdit. It enables you to synchronize any file in your workspace with other files stored in your **Google Drive**, your **Dropbox** and your **GitHub** accounts. This allows you to keep writing on other devices, collaborate with people you share the file with, integrate easily into your workflow... The synchronization mechanism takes place every minute in the background, downloading, merging, and uploading file modifications. There are two types of synchronization and they can complement each other: - The workspace synchronization will sync all your files, folders and settings automatically. This will allow you to fetch your workspace on any other device. > To start syncing your workspace, just sign in with Google in the menu. - The file synchronization will keep one file of the workspace synced with one or multiple files in **Google Drive**, **Dropbox** or **GitHub**. > Before starting to sync files, you must link an account in the **Synchronize** sub-menu. ## Open a file You can open a file from **Google Drive**, **Dropbox** or **GitHub** by opening the **Synchronize** sub-menu and clicking **Open from**. Once opened in the workspace, any modification in the file will be automatically synced. ## Save a file You can save any file of the workspace to **Google Drive**, **Dropbox** or **GitHub** by opening the **Synchronize** sub-menu and clicking **Save on**. Even if a file in the workspace is already synced, you can save it to another location. StackEdit can sync one file with multiple locations and accounts. ## Synchronize a file Once your file is linked to a synchronized location, StackEdit will periodically synchronize it by downloading/uploading any modification. A merge will be performed if necessary and conflicts will be resolved. If you just have modified your file and you want to force syncing, click the **Synchronize now** button in the navigation bar. > **Note:** The **Synchronize now** button is disabled if you have no file to synchronize. ## Manage file synchronization Since one file can be synced with multiple locations, you can list and manage synchronized locations by clicking **File synchronization** in the **Synchronize** sub-menu. This allows you to list and remove synchronized locations that are linked to your file. # Publication Publishing in StackEdit makes it simple for you to publish online your files. Once you're happy with a file, you can publish it to different hosting platforms like **Blogger**, **Dropbox**, **Gist**, **GitHub**, **Google Drive**, **WordPress** and **Zendesk**. With [Handlebars templates](http://handlebarsjs.com/), you have full control over what you export. > Before starting to publish, you must link an account in the **Publish** sub-menu. ## Publish a File You can publish your file by opening the **Publish** sub-menu and by clicking **Publish to**. For some locations, you can choose between the following formats: - Markdown: publish the Markdown text on a website that can interpret it (**GitHub** for instance), - HTML: publish the file converted to HTML via a Handlebars template (on a blog for example). ## Update a publication After publishing, StackEdit keeps your file linked to that publication which makes it easy for you to re-publish it. Once you have modified your file and you want to update your publication, click on the **Publish now** button in the navigation bar. > **Note:** The **Publish now** button is disabled if your file has not been published yet. ## Manage file publication Since one file can be published to multiple locations, you can list and manage publish locations by clicking **File publication** in the **Publish** sub-menu. This allows you to list and remove publication locations that are linked to your file. # Markdown extensions StackEdit extends the standard Markdown syntax by adding extra **Markdown extensions**, providing you with some nice features. > **ProTip:** You can disable any **Markdown extension** in the **File properties** dialog. ## SmartyPants SmartyPants converts ASCII punctuation characters into "smart" typographic punctuation HTML entities. For example: | |ASCII |HTML | |----------------|-------------------------------|-----------------------------| |Single backticks|`'Isn't this fun?'` |'Isn't this fun?' | |Quotes |`"Isn't this fun?"` |"Isn't this fun?" | |Dashes |`-- is en-dash, --- is em-dash`|-- is en-dash, --- is em-dash| ## KaTeX You can render LaTeX mathematical expressions using [KaTeX](https://khan.github.io/KaTeX/): The *Gamma function* satisfying $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ is via the Euler integral $$ \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,. $$ > You can find more information about **LaTeX** mathematical expressions [here](http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference). ## UML diagrams You can render UML diagrams using [Mermaid](https://mermaidjs.github.io/). For example, this will produce a sequence diagram: ```mermaid sequenceDiagram Alice ->> Bob: Hello Bob, how are you? Bob-->>John: How about you John? Bob--x Alice: I am good thanks! Bob-x John: I am good thanks! Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row. Bob-->Alice: Checking with John... Alice->John: Yes... John, how are you? ``` And this will produce a flow chart: ```mermaid graph LR A[Square Rect] -- Link text --> B((Circle)) A --> C(Round Rect) B --> D{Rhombus} C --> D ```