나는 완전히 개발 된 시스템을 연구하도록 요청했다. 나는 그것이 어떻게 작동하는지 이미 이해하지만 그것을 문서화하는데 어려움을 겪고있다. 가능한 클라이언트가 IT 배경 없이도 내 설명을 쉽게 이해할 수 있기를 바랍니다. 이 시스템은 많은 응용 프로그램과 많은 사용자로 구성됩니다. 나는 무엇을 취해야하는지 알지 못한다. 당신이 완전히 개발 된 시스템 문서화를 도울 수 있기를 바랍니다. How-to 단계를 나에게 줄 수 있다면 좋을 것입니다. 미리 감사드립니다.완전히 개발 된 시스템을 문서화하는 방법은 무엇입니까?
시스템의 주요 기능 (예 : 급여, 재고, 인사 기록 등)을 맨 위에서 시작하십시오. 주요 기능에 대한 단서는 시스템을 사용하는 부서에서 찾을 수 있습니다. 각 부서에서 주요 기능 목록을 다시 작성하십시오. 가능한 한 멀리 반복 과정이 반복됩니다. 개념은 일반적으로 시작하여 세부 사항쪽으로 아래로 작업하는 것입니다. 이 방법은 모든 함수/프로세스/etc. 해결 될 것입니다. 세부 사항으로 시작하여 위쪽으로 작업하면 매우 기본적인 기능을 놓칠 수 있습니다.
이것은 내가 지금하고있는 일입니다. 나는 옳은 일을하고있어서 기쁩니다. 그러나 또 다른 우려는 시스템의 각 사용자마다 USE CASE를 작성해야합니까? – iamanapprentice
사용자 설명이 복잡하거나 이해하기 어려울 경우 유스 케이스가 적절할 수 있습니다. 총알 목록이나 간단한 예제만으로 충분할 수도 있습니다. 무엇이 최선인지는 대상 독자, 즉 그러한 문서의 전형적인 사용자에 달려 있습니다. 너무 자주이 문서는 상사, 교사 또는 다른 엔지니어에게 인상을 남기도록 작성되었습니다. 예를 들어 위대 해 보이지만 쓸모가없고 이해하기 어려운 소유자 설명서를 읽으십시오. - 그들은 최종 사용자가 아니라 잘못된 청중을 대상으로 작성되었습니다. – StrangeDucks
대단히 고맙습니다 @ StrangeDucks :) 큰 도움이되었습니다^_ ^ – iamanapprentice
사용 된 언어, 사용 언어 등은 무엇입니까? 이 작업을 수행하는 미리 만들어진 패키지가 있습니다. – Chris
@Chris - Windows를 사용하고 있습니다. 응용 프로그램은 java 및 jsp를 사용하여 만들어졌습니다. – iamanapprentice