로그인을 해주세요
소프트웨어 개발자를 위한 기술문서 마스터 클래스
- 교육기간
- 30일
- 강의구성
- 0차시
- 교육시간
- 6시간
기술문서는 소프트웨어 개발자에게 단순한 텍스트가 아니다. 개발에 있어 가장 효율적인 커뮤니케이션 도구이자 핵심 수단이다.
기술문서를 어떻게 작성하느냐에 따라 프로젝트가 성공할 수도, 실패할 수도 있다. 이 강의에서는 팀과 고객에게 신뢰를 주고, 프로젝트를 성공으로 이끄는 효율적인 기술문서 작성 스킬을 안내한다.
남정현 강사는 이 클래스를 위해 개발자로서 테크니컬 라이터 업무를 겸하며, 현장에서 부딪히고 경험하며 쌓아온 기술문서 작성의 핵심 노하우를 공개했다.
이 강의와 함께라면 프로젝트를 성공시키고, 훌륭한 개발자로 성장하기 위해 꼭 필요한 실무 스킬을 습득할 수 있다.
▶교육대상
1. 소프트웨어 개발자로서 기술문서 작성 역량을 강화하고 싶은 사람
2. 주석, API 문서, 보고서, 회의록 등 실무에서 자주 쓰는 문서들을 잘 쓰고 싶은 개발자
3. 비개발자와 협업할 때 명확한 문서로 소통하고 싶은 엔지니어
4. 개발 외에 글쓰기 역량도 필요한 신입/주니어 개발자
5. Markdown을 활용한 문서 정리, README 작성 등에 익숙해지고 싶은 사람
▶학습내용
1. 업무적 글쓰기란 무엇인가
2. 업무적인 글을 체계적으로 쓰기 위한 3단계
3. 업무적 글을 잘 쓰기 위한 다섯 가지 노력 1
4. 업무적 글을 잘 쓰기 위한 다섯 가지 노력 2
5. 소프트웨어 프로젝트 문서화해보기
6. 소스 코드에 주석 달기
7. API 개발문서 작성하기
8. 장애 대응 보고서 작성과 회고하기
9. 회의록과 메일 쓰기
10. AI 기반 콘텐츠 작성 및 번역 그리고 윤문
11. 마크다운 사용하기
12. 마크다운 문서 작성해보기
13. 마크다운으로 만드는 다양한 콘텐츠
14. 웹 API 문서화 체험해보기
▶수료기준
|
항목 |
진도율 |
진행단계평가 |
최종평가 |
과제 |
수료점수 |
|
평가비율 |
100% |
0% |
0% |
0% |
60점이상 |
|
수료조건 |
80% |
없음 |
없음 |
없음 |
※ 수료기준은 각 평가항목의 점수가 수료기준 점수 이상이고 총점이 60점 이상이어야 합니다.
