당신의 팀에 문서가 있는지 묻고 싶습니다. 기록하려면 어떤 콘텐츠에 특별한 문서가 필요합니까?

저는 1년 넘게 스타트업 회사에서 처음부터 프로그램을 작성해 왔습니다. 이제 상사가 신입생이 프로젝트를 빨리 시작할 수 있도록 문서화하고 싶어합니다. 무엇을 작성해야 할지 모르겠습니다. 잠시 후 다른 동료에 의해 코드가 변경되어 문서가 잘못되었습니다. 아니면 어떻게 작성해야 합니까?

답글 내용:

저는 1년 넘게 스타트업 회사에서 처음부터 프로그램을 작성해 왔습니다. 이제 상사가 신입생이 프로젝트를 빨리 시작할 수 있도록 문서화하고 싶어합니다. 무엇을 작성해야 할지 모르겠습니다. 잠시 후 다른 동료에 의해 코드가 변경되어 문서가 잘못되었습니다. 아니면 어떻게 작성해야 합니까?

1. 코드 수정 기록

2. 데이터베이스 수정 기록

3. 문제 및 해결 방법

4. 동료가 변경한 경우 문서 뒷면까지 업데이트하도록 요청하고 직접 바꾸지 마세요.

회사 프로젝트의 기본 프로세스와 사양을 먼저 설명하는 것이 더 낫다고 생각합니다. 예를 들어, 신입사원은 회사의 이전 작업 기록을 반드시 알지 못할 수도 있고, 중복 작업을 하고 장난을 칠 수도 있습니다. 먼저 회사의 프로젝트에 사용되는 일부 도구, 프레임워크, 플랫폼에 대한 기본 소개와 관련 링크를 간략하게 설명한 다음 회사의 코딩 표준, 기본 업무, 작업 계획(Todo) 및 코드 관리에 대해 설명합니다. 작업 프로세스는 초보자가 계속해서 함정에 빠지는 것을 방지하기 위해 몇 가지 문제와 솔루션을 언급합니다. 마지막으로 회사의 비즈니스에 포함될 수 있고 배워야 할 일부 기술 스택을 초보자에게 권장할 수 있습니다.

php 오픈소스 DokuWiki

이건 원래 함정이었는데 개발중에는 안썼는데 지금 쓰네요.
하지만 참고할 수는 있습니다.
시스템 디자인 문서, 데이터베이스 디자인 문서, 인터페이스 디자인 문서, 웹사이트 배포 구성 문서, 웹사이트 사용 지침 문서 등