Documentation
README
한국어 기술 문서 제작
워드프로세서로는 나오지 않는 품질의 문서를, 자립형 HTML 한 파일로 제작한다.
결과물의 조건 세 가지. 디자인 시스템이 고정되어 매번 같은 품질이 산출된다. 수치와 도해가 데이터에서 나오고 손으로 타이핑되지 않는다. 네트워크 없이 열어도, 인쇄해도 동일하게 보인다.
문장 규약은 korean-report-style 스킬이 담당한다. 이 스킬의 범위는 제작에 한정한다.
1. 시작 전 결정
1.1 모드
| paper | deck | |
|---|---|---|
| 용도 | 분석 · 벤치마크 · 기술보고 · 진행현황 | 회의 · 아젠다 · 의사결정 요청 |
| 방향 | 세로 | 가로 |
| 페이지 | 연속 흐름 | 1 섹션 = 1 페이지 |
| 본문 폭 | 720px | 1120px |
| 밀도 | 산문 전체 | 한 페이지에 한 가지 |
| 템플릿 | assets/paper_template.html |
assets/deck_template.html |
| 본문 구조 | <div class="doc"> 안의 <section> |
<section class="tile ..."> 나열 |
섞지 않는다. 문단이 긴 deck 은 잘못 조판된 보고서로 읽히고, 타일 배경을 쓴 paper 는 슬라이드를 잘못 인쇄한 것으로 읽힌다.
1.2 산출물 필요 여부
This is the opening of the README. Read the full README on GitHub.