저는 보험 회사에서 일합니다. 우리는 거의 150 명으로 구성된 자체 개발 부서와 일부 공급 업체 (아웃소싱 및 맞춤형 응용 프로그램)를 보유하고 있습니다. 우리 회사에서 우리 팀은 비 기능 논리 라이브러리라고 불리는 것을 만들었습니다. 즉, 우리 부서의 모든 개발 팀에 수평 적으로 작용하는 소프트웨어 라이브러리입니다. 보안, 웹 서비스, 로깅, 메시징 등. 대부분 또는이 도구는 사실상의 표준을 처음부터 적용하거나 수정 한 것입니다. 예를 들어 우리의 로거는 로깅 메시지를 DB에 저장하는 Log4J를 기반으로하는 appender입니다. 또한 응용 프로그램에서 사용할 라이브러리 (예 : 웹 서비스 용 프레임 워크)를 정의합니다. 우리는 모든 조직에서 꽤 많은 JavaEE와 Oracle AS를 사용합니다 (일부 Websphere Application Server 포함).소프트웨어 환경 문서 체크리스트
이 프로젝트의 대부분은 문서화 된 아키텍처 (유스 케이스, UML 다이어그램 등)를 가지며 일반적으로 생성 된 문서를 사용할 수 있습니다. 이제까지 우리가 보았던 것은 사용자가 때때로 우리가 제공하는 라이브러리를 사용하기가 어렵고 끊임없이 질문하고 있거나 간단히 사용하지 않는다는 것입니다.
그래서 우리는 좀 더 친숙한 설명서를 만들 계획이므로 궁금한 점이 있습니다. 소프트웨어 설명서에서 제공하는 모범 사례 또는 체크리스트는 무엇입니까?
뭔가 내 마음에 오는 :
- API 참조 가이드
- 빠른 시작 자습서
- API 생성 된 문서.
- 는 검색
- 웹 액세스이어야합니다
그것은 다른 무엇을해야합니까? 또한 경험에 기반하여 유지 보수 (최신 상태로 유지)하고 이러한 유형의 문서를 게시하는 가장 좋은 방법은 무엇입니까?