문서 작성 및 편집
AB Projects의 문서는 전체 버전 기록을 갖춘 Markdown 페이지입니다. 작성과 편집은 실시간 미리 보기가 있는 사이드 패널에서 이루어지며, 모든 변경 사항이 기록되어 팀이 무엇이 왜 변경되었는지 항상 알 수 있습니다.
페이지 작성
- 프로젝트의 문서 영역에서 새 페이지를 시작하십시오. 제목, 선택적 상위 경로(기본값은
/— 중첩하려면onboarding과 같은 값을 설정), 선택적 태그를 지정하십시오. - 본문은 Markdown으로 작성하십시오. 편집기는 입력하는 동안 렌더링된 결과를 볼 수 있도록 소스 옆에 실시간 미리 보기를 표시합니다.
- 저장하면 페이지가 트리에 게시됩니다. 버전 1이 됩니다.
페이지 편집
- 페이지를 열고 (페이지의 작업 메뉴에서) 편집을 선택하십시오. 현재 Markdown이 담긴 동일한 패널이 열립니다.
- 편집할 때는 편집 노트가 필요합니다. 변경 사항을 저장하기 전에 무엇이 변경되었는지 설명하는 짧은 노트를 입력해야 합니다 — 비워 두면 AB Projects가 "팀이 무엇이 변경되었는지 알 수 있도록" 노트를 추가하도록 요청합니다. (새 페이지에는 노트가 필요 없고, 편집에는 필요합니다.)
- 저장하면 덮어쓰는 대신 새 버전이 생성됩니다 — 이전 버전은 보존됩니다.
버전 기록 및 복원
- 모든 페이지는 버전 번호와 최근 편집자 및 시간을 추적합니다.
- 페이지의 작업 메뉴에서 기록을 열어 각 편집 노트와 함께 이전 버전을 확인하십시오 — 모든 변경의 "이유"가 기록에 남습니다.
- 기록 목록에서 이전 버전을 복원할 수 있습니다. 복원하면 해당 콘텐츠가 현재 페이지로 돌아오며(그리고 그 자체가 새 버전으로 기록됨).
페이지 삭제
- 삭제는 페이지의 작업 메뉴에서 사용할 수 있으며, 실수로 클릭되지 않도록 의도적으로 편집/기록과 떨어진 곳에 배치되어 있습니다.
- 삭제하면 페이지가 트리에서 제거됩니다. 신중한 작업으로 다루십시오 — 콘텐츠만 변경하면 되는 경우 삭제보다 편집이나 복원을 선호하십시오.
팁
- 페이지의 평면 목록 대신 상위 경로를 사용하여 명확한 구조를 만드십시오(예:
engineering/runbooks). - 의미 있는 편집 노트를 작성하십시오 — 기록에 표시되며 팀원이 diff 없이 변경 사항을 이해하는 데 의존하는 정보입니다.
- 저장하기 전에 실시간 미리 보기를 사용하여 서식(제목, 코드 블록, 링크)을 확인하십시오.
- 편집이 잘못된 경우 기억에 의존해 다시 작성하지 말고 기록에서 이전 버전을 복원하십시오.
Markdown, 실시간 미리 보기, 필수 편집 노트, 복원이 포함된 전체 기록을 통해 문서는 작성하기 쉽고 변경하기 안전하게 유지됩니다.