Sign In

검색

2021년 1월 4일 문서화 팀 회의록

2021년 1월 4일에 문서화 팀에서 미팅이 있었는데, 그 내용을 간략히 정리해봤습니다 :)

 

이하 본문

 


 

문서팀은 소개 및 향후 문서화 작업을 위한 의제를 설정하고, 이름을 말해서 안되는 어떤 회사를 뒷담하기 위해 만났었습니다.

 

다음은 지금까지에 있어 Rocky Linux의 문서화 작업이 지향하고자 하는 것들입니다.:

  1. 기여자(Contributors)들이 볼만한 스타일 가이드를 만들자
    • 문서는 브랜딩과 접근성 모두를 위해 짜임새 있고, 논리 정연하며 일관된 경험들을 나타내야 합니다.
  2. 독자의 기술적인 수준에 대한 가정은 최소화합니다. 리눅스에 대한 경험이 충분치 않은 사용자 혹은 관리자를 위해서 작성해야 합니다.
  3. 문서 내에 예제는 많을수록 좋습니다.
    • 명령줄 인수나 변수(예를 들어 환경변수 등)에 대한 설명을 포함하는 것이 좋습니다.
  4. Rocky Linux 버전 간의 문서 버전을 변환할 수 있어야 합니다. (예: https://www.zabbix.com/documentation/current/)
    • 현재 시점에서는 이 기능을 제공하기 위한 방법을 검토하고 있습니다.
  5. 단계별로 문서화를 살펴보고 결과를 복제하기 위해 플레이 테스터를 지정합니다.
    • 이런 플레이 테스터들 중 일부는 상대적인 초보자들이 될 것이며, 덕분에 이분들은 이제 미니 PC를 구입할 핑계거리가 생겼군요.  smiley
  6. 문서화를 진행하기 전에 사전 필요 지식에 대한 기대치를 정합니다. (2번 참조)
    • 예. "이 가이드를 따르려면 RPM 패키지 설정 방법을 알아야 합니다. 이런 절차에 익숙하지 않다면 'RPM 패키지 설치 가이드'를 참조하시길 바랍니다."
  7. 문서의 기술적 내용과 문서의 문법/작성 스타일을 승인할 별도의 사람(혹은 팀)을 지정합니다.
  8. 피드백을 위한 채널을 문서 상에 추가합니다.
    • 다음과 같은 것들이 포함될 수 있지만, 따로 제약하진 않습니다: 개별 문서 페이지의 댓글, GitHub 이슈, Mattermost(?), 봉화와 하늘을 원망하기(!)
  9. 독자들이 공개적으로 댓글을 달 수 있도록 구현합니다. (오타 신고 등) (8번 참조)
    1. 이런 댓글들을 Mattermost(IRC, Matrix, 기타 등등...)와 연동되도록 통합
  10. 문서화 대상이 되는 그룹들을 나열하고 누가 주요 대상 그룹인지 고려합니다.
    • 초보자는 아니지만 CentOS를 교체하려고 하는 숙련된 시스템 관리자일 것입니다. 각기 다른 대상 그룹들에 서비스를 제공하는 여러 병렬 문서화 프로젝트가 있을 수 있습니다.
    1. 다른 Rocky Linux 버전 사이에서의 버전 관리: 8 -> 9 -> 10...??
    2. 아래와 같은 것들이 포함:
      1. 시스템 관리자를 위한 기술 문서(모든 버전에 해당). 아마 주요 독자일 것입니다.
      2. "초보자"들을 위한 하우투 페이지.
      3. YouTube의 비디오 과정: 같은 팀이 관리하는게 아니라 병렬 팀이 관리하는 병렬 "문서화 프로젝트"의 예시라고 볼 수 있습니다.
  11. 비영어권 원어민을 위한 문서의 단순 영문 버전을 준비합니다.
  12. Hugo에 대한 회의 준비? (회의에서 부분적으로 언급됨)
  13. 회의록, 진행 계획의 다음 단계와 일정/출시일을 요약합니다. (예: 이 문서에 추가).
  14. 예제 터미널의 구현?
    • 즉, 클라우드 머신에서 문서에 나열된 명령을 시도할 수 있는 곳: https://kubernetes.io/docs/tutorials/hello-minikube/ 참조
  15. 써드파티로부터 검증된 동영상을 삽입합니다.
  16. 초보자 문서를 위한 친근하고 실용적인 작성 스타일
  17. 빌드된 정적 문서 사이트를 ISO에 추가
    1. 오래된 내용일 수 있다는 경고와 함께 온라인 버전에 대한 링크를 포함
  18. 저장소 위치 설정: learn.rockylinux.org -> docs.rockylinux.org
  19. 레드햇 리눅스 버전과의 호환 관리 (8 -> 9, ...) (4번 참조)
    1. 문서 버전과 문서화되는 제품의 버전을 구분
Comment 0개