Por lo general, la razón por la cual existe la documentación es porque no desea dedicar su tiempo a responder las mismas preguntas una y otra vez. Así que supongo que un buen punto de partida sería mirar el tipo de preguntas que hacen sus clientes y ver si hay preguntas recurrentes. Si los hay, asegúrese de que sean parte de su documentación.
Una vez que tenga una idea del tipo de artículos de la base de conocimiento que desea escribir, probablemente tenga sentido organizar el contenido para que sus usuarios puedan navegar fácilmente. Por ejemplo: haga un capítulo completo / elemento de menú / espacio sobre cómo ayudar a las personas a comenzar (cómo instalo y configuro el software, cuáles son los siguientes pasos).
Visite Confluence Documentation Home para inspirarse. Por cierto, puede usar Confluence para escribir y publicar su documentación (entre muchas otras cosas).
- Si programas como Hack Reactor son legítimos, ¿por qué la gente se molesta con los títulos en informática de las universidades tradicionales? ¿Alguien tiene experiencia con un programa como Hack Reactor y pueden dar fe de su éxito en comparación con la universidad normal?
- ¿Debo actualizarme a Fedora 24 (desde 23) ahora o esperar?
- Si pudieras mejorar cualquier producto de Microsoft, ¿qué harías?
- Cómo explicarle a un agricultor qué es la informática y qué hace un ingeniero de software
- ¿Alguna idea para optimizar una arquitectura de computadora (ISA) para un conjunto determinado de algoritmos?
