개발 Q&A

제목 설계 및 개발중에서 나타나는 문서화의 문제점에 대한 질문입니다.
카테고리 기타
글쓴이 브레인토스트 작성시각 2016/11/21 11:43:31
댓글 : 3 추천 : 0 스크랩 : 0 조회수 : 12378   RSS

저는 스타트업에서 일을 하고 있는데요.

그러다보니 폭포수모델이라던가 TopDown 형태가 아니라

소프트웨어는 거의 애자일이나 스크럼과 같은 성향이 강한데요.

그러다보니 문서는 거의 개발과 관련된 핵심 Flow에 대한 UI 문서들과

개발 시 사용하는 Controller, Model과 같은 설계서와 명세서 정도입니다.

그런데 이번에 이제 마케팅쪽에서 어떤 이슈가 생겨났고 그에 의해서 많은

구조변경이 일어날 것 같은데요. 그래서 이제 비지니스 파트에서 기존에 UI 중심의 Flow정리 말고

Fucntion 위주의 명세와 Flow가 필요할 것 같다고 합니다.

(이유는 UI중심이다보니 문제가 생기면 UI 디자인이 너무 자주변경 그래서 개발에서도 수많은 변경이 일어남, 시간의 지체가 많다. 등이 있습니다.)

하지만 잘 이해가 안됩니다.. 정확히 어떤 것을 원하는지 잘 모르겠고 앱 같은 경우에는 Activity에 의해서

Flow를 Chart로 만들거나 하는 게 좀 더 명확한데 웹 같은 경우에는 한 화면에서 빠져 나갈 수 있는

링크나 분기되는 것들이 상대적으로 많다보니 어떤식으로 문서화해서 공유해야할지 감이 잘 안옵니다.

혹시 참조할 링크같은 것들이나 조언 해주시면 감사하겠습니다 ㅠ

 

현재 생각한것은 테이블 형태로 한화면에서 이동 가능한 화면의 내용과 이화면에서 작동해야하는 Function을 명세서의 형태로

테이블로 쭉 늘어뜨리는 형태를 생각하고 있는데.. 어떨까요 ??

 

메인화면

기능: 로그인, 아이디 비밀번호 찾기, 로그아웃

다른 경로: 게시판, 공지사항 ...

이런 형태의 테이블이 예상되는데 더 좋은방법이 있으면 추천해주시거나 참조 링크를 주시면 확인해보겠습니다 ㅠ

 다음글 월마다 한개의 날짜를 생성할려고 하는데 날짜 생성시 간... (4)
 이전글 이러한 처리는 코드이그나이터에서는 어떻게 처리해야될까요... (1)

댓글

kaido / 2016/11/21 12:31:23 / 추천 1

저는 DB 스키마 부터 뽑아서 봅니다.

그리고 페이지별로 사용되는 DB 테이블만 묶어서 나열해 봅니다.

이러다 보면 사용할 쿼리가 대충 감이 오고, 이걸 모으면 모델이 나옵니다.

 

그리고 back end 와 front end 의 기획은 분리하시는게 좋습니다.

UI를 따라가긴 하지만, UI에 종속되진 않아야 하거든요.

브레인토스트 / 2016/11/21 13:58:44 / 추천 0

@kaido

음.. 프론트와 백엔드 얘기라기보다는..

기능단위의 플로우차트를 만들 수 있는 방법이 있는지 궁금합니다 ㅠ

그 플로우 차트에 어떤 명세도 포함한 상태로 말이죠.. 도저히 머릿속에서 상상이안가서 ..

하늘치 / 2016/11/22 16:25:11 / 추천 0

음.. 저에게도 꼭 필요한 내용이군요.

 

먼저, 위에서 작성하신 글 내용으로 볼 때, 두 가지 형태의 문서를 만들어야 할 것 같다는 생각이 듭니다. 

하나는 페이지의 주요 내용과, 링크(기능) 정리 이고요,

또 하나는 각각의 링크 플로우 정리입니다.

 

메인 페이지를 기준으로 예를 들어보면..

[문서1 : 문서 내용 및 링크 정리]

 - 페이지의 주요 내용

 - 로그인, 로그아웃, 회원가입, 마이페이지, 공지사항 등..

 

[문서2 : 기능 플로우 정리]

 - 로그인 : /user/login ▶ /user/login/proc ▶ 로그인을 시도했던 페이지로 redirect

 - 회원가입: /user/join ▶ /user/join/proc ▶ 회원가입 후 안내 메시지 페이지 ▶ 회원가입을 시도했던 페이지로 redirect

 

[문서1] 은 그 때 그 때 필요한 것만 적시해서 작성하면 될 것 같아요.

[문서2] 는 한 번만 정리해두면 크게 변경될 건 없을 것 같고요. 이건 참조 문서 정도로 봐도 될 것 같기도 하네요.

 

 

 

적다보니.. 이게 맞나 싶기도 하고, 저한테 필요한 대로만 적었네요..

하신 말씀 토씨만 다르게 해서 똑같은 말을 하고 있는 것도 같고요.. 헛헛헛;;;