개발 문서? 작성 질문 드립니다

Question

안녕하세용.병원 전산실에서 일하는 신입입니다.문서 작업에 감을 못잡아서 도움을 구하고자 합니다.글이 길지만 부디 도와주십셔...병원에 메인 프로그램들은 파워빌더라는 옛날 툴로 만들어져있고,사이드? 느낌인 것들은 웹으로 만들어져 있습니다.근데 이게 옛날에 만든 것들이라, 관련 문서같은 건 아무 것도 없이 코드만 달랑 남겨져 있습니다.이걸 과장님들의 요청으로, 문서화를 시켜야 하는 상황입니다.병원 업무 흐름을 생각하면서 따라가다 보면, 다행히 코드의 의미 자체는 쭉 해석이 가능한 상태입니다.근데 문서화를 어떤 식으로 해야 하는 지 전혀 감이 안옵니다.예시를 간단하게 들어보면 대충 이런 느낌입니다.아래 그림에서 진도가 안나갑니다... 흑흑메인|------ 공지사항 목록-------- 공지사항 상세|------ 사원 목록 ----------- 사원정보 상세1. 사원 목록 페이지에서 데이터 표현에 사용되는 값? (이름, 사번, 입사년도 등등) 은 어떻게 표시하지?페이지 관계도만 나오는 파일, 페이지에 쓰이는 데이터만 모은 파일 등으로 파일을 구분해야 하나?2. 해당 페이지에 존재하는 기능들은 어떻게 표현하지? (등록, 수정, 삭제 등등)3. 그리고 제일 문제인게 기본적으로 어떤 종류의 문서들을 만들어야 하는 지를 모르겠습니다...문서들 종류는 다양하게 알아봤는데, 그 많은 종류의 문서들을 전부 만들지는 않고, 몇몇개를 골라 쓸텐데어떤식으로 고르는 지 감이 전혀 안와요...

더미 · Answer

그런건 상사가 제공해줘야 됩니다

동도인 · Answer

회사에서 제공하는 양식이 있는지 여쭤보고 그 양식에 맞춰 작업을 하면 될거같습니다.

잠자는사자 · Answer

우선 RDB 쓸 테니테이블 명세서, ERD 만들면 될꺼고요UML을 이용한클래스 다이어그램, 유즈케이스 다이어그램, 시퀀스 다이어그램 이렇게 만들면 됩니다.

보름 · Answer

어떤 언어든 대입문, 사칙연산, 분기문, 반복문의 조합일 뿐입니다.파워빌더, 델파이, VB, C, C++은 물론이고 심지어 코볼, 포트란, 베이직도 마찬가지입니다.어셈블러가 아닌 바엔 말이죠.막연하게 문서화를 하라고 한다면 흔히들 데이터베이스와 관련된 것들을 먼저 떠올립니다.예를들어 테이블설계서, ERD이런것들이요.하지만 정작 가장 먼저 만들어야 하는 문서는 화면흐름도입니다.최초 업무가 어디서 시작되어 어떻게 흘러가는지 그리고 각각의 업무마다 그 업무를 처리하기 위한 화면이 어떤 화면인지에 대한 전체적인 흐름도가 그려지고 나서각각의 화면에서 사용되는 테이블이 어떤 것인지를 그리다 보면전반적인 업무 흐름은 저절도 파악됩니다.그것이 완성되고 나면 각 화면마다 어떤 처리와 계산이 이루어지는지 대강의 설명을 달면서 점 점 깊이 있는 분석이 됩니다.그러니 가장 먼저 해야 할 일은빈 깡통 상태의 데이터베이스에서 최초에 생성되는 데이터가 무었이고, 그 데이터가 어느 화면에서 입력되는지 부터 시작하세요.그렇게 문서를 하나 하나 만들어 가다 보면 어느 순간 PM이 되어 있을 것입니다.

프레이야 · Answer

기본적인건 요구사항정의서, 디비설계서, 화면설계서 3개정도인듯여.

catcode · Answer

아직은 기존 시스템의 흐름을 정확히 다 파악하지 못했을 확률이 높아보입니다.기존 시스템을 하나하나 짚어 가면서 PPT로 흐름도를 작성해보세요.처음부터 너무 거창하게 만들지 말고 최대한 가볍게 만드는걸 추천합니다 .

장독깨기 · Answer

이렇게 한 번 해보세요.병원에서 요구하는 기능들이 있을거잖아요.그리고, 해당 시스템은 요구에 맞는 기능을 제공하겠죠.우선 기능들을 리스트업 하세요. 엑셀로 작성하면 됩니다.그 기능들을 제공하기 위한 메뉴와 화면도 있겠죠.메뉴와 화면을 리스트업 하세요. 엑셀로 작성하면 됩니다.또한, 그 기능들을 만족하기 위한 데이터들이 있습니다.데이터 구조와 그 관계들도 정리를 해야 하는데요,ERD 편집 툴을 이용하면 됩니다.ERD 편집 툴은 www.erdspace.com 여기 한 번 이용해보세요. ㅎ테이블 명세서 까지는 당장 필요 없습니다. 데이터베이스 보면 다 나오잖아요.가령, 특정 기능을 단순히 하나의 메뉴에서 제공할 수도 있는데요,사용 시나리오가 필요한 경우도 많이 있습니다.유즈케이스 시나리오라 하는데요,이건 UML 툴을 이용해서 시퀀스 다이어그램을 이용하면 편할 것 입니다.어떤 경우는 순서도가 필요할 경우도 있습니다. 그럼, UML 툴 이용해서 작성하면 됩니다.어떤 시스템들이 있는지, 그 시스템이 어케 배포되어 있는지 이런 것도 정리해 둘 필요가 있습니다.파워포인트, 또는, UML 툴에서 컴포넌트 다이어그램을 이용하면 될 것 입니다.가령, 화면이 있습니다.화면 설계서란게 있는데요, 이건 개발하기 전에 화면을 참조하기 위한 설계서 입니다.지금 개발이 되어 있잖아요, 굳이 화면 설계서를 만들 필요가 있겠습니까. 별로 없겠죠.그러나, 그 화면에서 제공하는 요소나 주요 목적등은 정리할 필요가 있을 수 있습니다.그럼, 엑셀 또는 워드 문서로 작성하면 됩니다.이제 프로그래밍 입장에서 클래스나 플로우에 대해 정리 할 필요도 있을 것 입니다.그럼, UML 툴로 클래스 다이그램, 시퀀스 다이어그램을 이용하면 됩니다.이런 식으로 점점 구체화 하면 됩니다.무엇이 필요한지 생각을 하고, 그걸 작성하면 되겠죠.문서를 확정하고 거기에 끼워 맞추려면 원하는걸 작성하기 힘듭니다. ㅎ너무 부담 갖지 마시고, 천천히 하나 하나씩 해보세요. :)아, ERD 편집 툴은 www.erdspace.com 입니다. ㅎ돈 많으면 ErWin, DA# 이런 것도 있는데요, 굉장히 고가 입니다. 이건 상사와 의논해서 결정하시구요,UML 툴은 무료로 제공되는 것들이 많이 있습니다.ppt 같은 단순 드로잉 툴로 작업하면 손도 많이가고 시간 허비가 많습니다.UML 툴 검색해서 적당한거 하면 될 거 같습니다.

캐티 · Answer

그냥 세계적인 RFC 문서 작성 룰을 따르는 것은 어떠나요. 이렇다고 논문을 쓰라는 거는 아니고요.

hswdreamer · Answer

데이터 정리 : 테이블 명세서기능 종류 : 기능 명세서, 유스케이내부 동작 : 시퀀스

개발 문서? 작성 질문 드립니다

9개의 답변

기술 목록