Você pode começar entrevistando seus usuários internos sobre o software e descobrir que tipo de informação eles gostariam de saber.
Grande parte da documentação que escrevi sobre software teve em mente um ou muitos públicos. Seu departamento de treinamento provavelmente se beneficiaria de um esqueleto de tópicos (como um sumário). Então, você pode discutir quais tópicos são relevantes e quais são irrelevantes para os objetivos de treinamento.
Alguns dos tópicos podem abranger:
- Público alvo)
- Requerimentos técnicos
- Como instalar (se aplicável)
- Processo (ou seja, que função comercial o software executa?)
- Conjunto de recursos (que recursos o software possui?)
- Você pode ter uma abordagem baseada em tarefas para isso, por exemplo, Adicionar um usuário ou Adicionar um documento
- Você poderia ter uma abordagem baseada em objetos, por exemplo, Usuários, Funções
- Você pode ter uma abordagem baseada em menus, por exemplo, menu Arquivo, Exibir menu
- Por fim, possivelmente uma seção Próximos recursos e Perguntas frequentes pode atuar como um crescente repositório de conhecimento do seu produto.
Tente antecipar como seus usuários finais usam seu software, com base no seu conhecimento de desenvolvê-lo, no seu conhecimento do que ele faz e também com base (espero) em suas entrevistas com os usuários finais.
Mais importante, tente criar a documentação que você gostaria de ler, use nomes de exemplo divertidos para demonstrar e use muitas capturas de tela anotadas.
Espero que isto ajude