[SI 개발자 이야기] 10. SI 프로젝트에서 문서화란?

SI 개발자 이야기

#10. SI 프로젝트에서 문서화란?

---

si 프로젝트에서는 고객사에게 프로젝트를 잘 만들었다는 증거로 문서를 제출해야한다.

제안서부터 시작해서 화면정의서, 설계서, 사용자 메뉴얼 등 프로젝트 단계에 따라서 프로젝트 제안부터 설계, 개발, 테스트, 오픈 후 운영까지 작성해야 할 문서들이 존재하는데 보통은 신입 개발자들이 담당하게 된다.

문서를 작성하다 보면 내가 이러려고 개발자를 했나 사무직인가 착각이 들곤 한다. 또한 대한민국에서는 각 단계별로 수행해야할 문서화를 프로젝트 종료 직전에 몰아서 하는 경우가 많은데, 그 이유는 다음과 같다.

1. 프로젝트 기간이 짧기 때문에 최대한 빠르게 만들고 문서는 그럴듯 하게 만들어서 기간 내 프로젝트를 수행하기 위함
2. 어차피 단계별로 만들어도 요구사항은 추가되고, 변경되기 때문에 만들고 수정하는 것보다는 다 만들어놓고 거기에 맞춰서 작성하는게 더 빠르다.

아이러니하게도 순서가 잘못되었지만, 한국의 si 문화에서 자연스럽게 진화(?)한 방식이다.

반응형

화면정의서를 그리는 툴은 많지만, 완성된 운영 화면을 캡쳐해서 화면정의서를 만드는 기적 같은 장면을 볼 수 있다.

보통 개발자들은 문서작성이라고 하면 극혐하지만, 어쩌겠나 당신은 신입인걸. 

제일 만만한 신입사원들이 문서화를 담당하게 된다. 어차피 개발은 바로 시키지 못 할 거 문서작성이라고 시키겠다는 것이다. 

어차피 내가 해봐야 다음에 후임에게도 시킬 수 있으니 기회가 될 때 열심히 만들어보자.

 

⬇️ 개발자 비전공 취업/이직/이력서/포트폴리오 관련 1:1 멘토링 신청하기 ⬇️

[개발자 멘토링]개발자 취업/이직/방통대/대학원/이력서/포트폴리오 등 멘토링 진행합니다.