지원 문서에 포함해야 할 핵심 요소는 무엇입니까? [닫은
-
03-07-2019 - |
문제
나는 an을 만들었다 '핸드 오버'가 필요한 응용 프로그램 다음 달에 지원 그룹에.
응용 프로그램입니다 상당히 작습니다 (2 개월 개발), 두 개의 클라이언트 측 응용 프로그램과 데이터베이스로 구성되며 Windows 플랫폼 용 C#로 작성되었습니다.
나는 광범위한 아이디어를 가지고 있습니다 지원 문서에 포함시킬 내용이지만 지금까지 내 경력에서 많은 지원 문서를 만들 필요는 없었으며 확실한 항목 목록을 포함하고 싶습니다.
나는 내 것 같아 목표 그것을 만드는 것입니다 모두의 삶 지원 그룹에서 더 쉬운 그리고 가능한 한 스트레스가 없습니다.
그래서 내 질문은 다음과 같습니다.
지원 문서에는 절대적으로 포함되어야합니다
추가 정보를 제공하여 추가 유용성을 제공하기 위해 지원 문서에 넣었습니다.
우리의 모든 삶을 쉽게하기 위해 손을 떼기 전에 어떤 다른 활동을 할 수 있습니까?
해결책
전문적 으로이 과정의 양쪽에 있었기 때문에 다음은 다음과 같이 말할 수 있습니다. 필수적인:
- 코드 문서 (Javadoc, Doxygen 등)
- 빌드 프로세스에 대한 세부 사항
- 현재 소스를 얻을 수있는 곳
- 버그를 제출하는 방법 (발생합니다)
- 소스 또는 고객에게 패치를 제공하는 경로
- 작동 방식 (단순하지만 종종 간과)
- 사용자 가시화 가능한 부분 (예 : 스크립팅 구성 요소가 있음)
- 각 구성 요소에 대한 1 차 접점, 일명 에스컬레이션 경로
- 그들이보고 싶은 다른 것에 대한 지원의 피드백에 대한 격려
나는 다른 많은 것들을 추가 할 수 있다고 확신하지만, 이것들은 내 마음에 최우선 순위입니다.
다른 팁
- 기능 사양 (하나가있는 경우)
- 사용자 매뉴얼. 없다면 하나를 만듭니다
- 포함 된 기술 매뉴얼
- 배포 다이어그램
- 사용 된 소프트웨어
- 구성 및 빌드 세부 사항
- 서버 IP 및 Admin / Oracle / WebSphere 비밀번호의 deatils
- 테스트 문서
- 오버 뷰 문서를보십시오
- 모든 문서가 보관되는 곳
- 버전 제어 저장소 및 프로젝트/ 사용자 세부 사항
- 응용 프로그램 사용자 이름 / 비밀번호
- 분석, 데이터로드 등 개발 팀이 작성한 SQL/Tools 등 모든 지원 SQL/Tools 등.
- 작업 및 출력의 스크린 샷을 포함하십시오.
- 종이 나 PDF 대신 "온라인으로 쉽게 업데이트 할 수있는"Doc (Wiki-Like)를 선호합니다.
- 온라인 인 경우 검색 가능하고 가교시킵니다.
- 사용자 관리는 깔끔한 것입니다 (그림, 설명, Aso).
- 응용 프로그램 내의 다른 기능의 요약
이것이 제가 지원 직원에게 "만"이라는 것이 "내 머리를 ontop하고 더 이상 개발하지 않는다면 내가 생각하고있는 것입니다.
제휴하지 않습니다 StackOverflow