나는 웹 서버에 관한 모든 문서로 가득 찬 탭이 있는 3링 바인더를 만들기 위해 ms word로 이것을 만들고 있습니다.
포함해야 할 주요 카테고리는 무엇입니까?
우리는 2개의 서버를 가지고 있습니다. 두 창 모두 웹용 1개, SQL 서버용 1개, 웹 1개는 iis7과 coldfusion을 실행합니다.
저는 시스템 관리자로서 교육을 받은 적이 없으며 단지 배운 내용만 있을 뿐입니다. 예를 들어, 정보가 없는 것보다 더 많은 정보를 갖고 싶은데, 예를 들어 방금 서버를 마이그레이션했을 때 문서가 없었기 때문에 많은 것을 놓쳤습니다.
그럼 본격적으로 해볼까? 나는 이것이 위키라고 생각하지 않지만, 내 상사와 동료들은 위키와 이를 사용하는 방법에 익숙하지 않습니다. 나는 우리 그룹에서 모든 i에 점을 찍고 모든 것을 문서화하고 싶어하는 항문 사람인 경향이 있습니다.
어떤 제안이 있으십니까?
답변1
어느 정도 당신이 포함하는 내용은 다음 사항에 따라 크게 달라집니다.WHO당신은 문서화하고 있습니다. 관리자를 위해 문서화하고 있습니까? 사용자를 위해? 프로그래머를 위한 것인가요? 무엇보다도? 사이트를 디자인할 때와 마찬가지로 사용 사례를 살펴보고 해결해야 합니다.
프로그래머 및/또는 시스템 관리자로서 나에게 제공되는 문서에 대해 중요하다고 생각하는 사항은 다음과 같습니다.
- 백업이 생성되는 방법
- 백업을 복원하는 방법
- 사이트를 처음부터 설정하는 방법(필수 소프트웨어, 설치 프로세스, 구성 등)
- 종속성 목록(CF, SQL Server 필요, x에 필요)
- 사용 중인 API에 대한 문서
- 원래 요구사항 문서, 변경 문서(존재하는 경우)
- 관리 생성/사용 방법에 대한 정보
- 사용자가 나갈 때 접근 권한을 변경하는 프로세스(사용자 접근 권한 취소, 공유 비밀번호 변경 등)
- 모든 사용자/클라이언트/프로세스별 사용자 정의
- 모든 "잡았어" 시나리오
- 사용자를 위한 기존 문서
- 예약된 작업 및 해당 일정
- 유지 관리의 일환으로 정기적으로 실행해야 하는 프로세스(인덱스 업데이트, 조각 모음 등)
Wiki와 같은 전자 소스를 만드는 경우 다음이 있으면 좋습니다.
- 원본 구성 요소 및 모형
- 이미지 소스
- 플래시 .fla 파일
- 기존 사이트에서 요구사항/변경 문서로의 링크
- 날짜/버전 등이 포함된 릴리스 코드의 현재 복사본 각 주요 릴리스 또는 정해진 일정(예: 월별)에 따라 업데이트됩니다.
답변2
Word 대신 OneNote를 문서화에 사용하세요
- 여러 사용자가 동시에 사용할 수 있습니다
- 원하는 경우 PDF로 내보내기
- 마우스 오른쪽 버튼을 클릭한 후 "onenote로 보내기" 기능을 사용하면 문서의 가치가 높아졌습니다.
- 편집 내용 추적
이는 기능 중 일부일 뿐입니다. 우리에게는 실제로 나열할 수 없을 정도로 많은 이점이 있습니다.