Quais são os elementos essenciais para incluir em Documentação de Suporte? [fechadas]

Question

Eu criei um aplicação que as necessidades de mão-over ' para o grupo de apoio no próximo mês.

O aplicativo é relativamente pequeno (desenvolvimento 2 meses), e consiste em duas aplicações do lado do cliente e um banco de dados, ele é escrito em C # para a plataforma Windows.

Eu tenho uma idéia geral do que incluir em um documento de suporte, mas eu não precisava fazer muito muitos documentos de apoio até agora na minha carreira e quero uma sólida lista de itens para incluir.

Eu acho que a minha objetivo é fazer com que os vida de todos no grupo de apoio fácil e livre de estresse quanto possível.

Então eu acho que minhas perguntas são:

1. O que um documento de suporte absolutamente conter

2. Que coisas adicionais você pôs em documentos de apoio para fazê-los extremamente útil.

3. O que outras atividades podem ser feitas antes da mão-over para fazer todas as nossas vidas mais fáceis?

Answer 1

Tendo sido em ambos os lados deste processo Profissionalmente, eu posso dizer que o seguinte deve ser obrigatório :

• a documentação do código (javadoc, doxygen, etc)
• detalhes sobre processo de construção
  • onde obter fonte de corrente
  • como erros de arquivo (que vai acontecer)
  • rota para fornecer patches, quer para a fonte ou para clientes
• como funciona (simples, mas muitas vezes esquecido)
• porções personalizada do utilizador-(por exemplo, existe um componente de script)
• contactos preliminares para cada componente, aka caminho de escalonamento
• encorajamento para o feedback de Apoio sobre o que mais eles querem ver

Eu tenho certeza que muitas outras coisas podem ser adicionadas, mas estes são a primeira prioridade em minha mente.

Answer 2

1. especificação funcional (se tiver)
2. Manual do usuário. Criar um, se você não tem
3. Manual Técnico, Contendo
   • diagrama de implantação
   • softwares utilizados
   • Configuração e detalhes de construção
   • deatils de IP do servidor e admin / oracle / websphere senhas
4. Document Testing
5. documento vista sobre dando
   • Onde todos os documentos são mantidos
   • repositório de controle de versão e os detalhes do projeto / user
   • usernames Aplicação / password
6. Qualquer suporte de SQL / ferramentas etc criado pela equipe de desenvolvimento, para análise, o carregamento de dados, etc.

Answer 3

1. Incluir Imagens de operações e de saída.
2. Prefere doc "on-line facilmente update-capazes" (wiki-like) em vez de papel ou pdf.
3. Se on-line, torná-lo pesquisável e reticulada.

Answer 4

• A usermanual é uma coisa pura (fotos, descrições, aso.)
• Um resumo dos diferentes recursos dentro do aplicativo

Isso é o que eu estou pensando ontop da minha cabeça, se este é "apenas" para o pessoal de apoio e não um maior desenvolvimento.