La clave para una buena documentación para una aplicación web es dividirla en muchos fragmentos o artículos pequeños. Recuerde que las personas harán referencia a su documentación, no la leerán de principio a fin. Por lo tanto, tener una URL única que responda a una pregunta específica puede ser realmente útil si está tratando de usar su documentación para responder a solicitudes de soporte.
Además, concéntrese en documentar tareas en lugar de características. Muestre a las personas cómo lograr cosas con su aplicación. No solo hable sobre cuáles son los diferentes botones.
Somos grandes creyentes en el uso de muchas imágenes también. Las capturas de pantalla ayudan a aclarar cosas en su documentación. De hecho, tenemos un producto que hace que crear y publicar su documentación sea muy, muy rápido. En la mayoría de los casos, puede documentar la mayor parte de su aplicación en aproximadamente medio día.
- ¿Cuáles son algunas buenas prácticas al transformar y almacenar en caché los datos en aplicaciones RESTful APIs?
- ¿Cuál es la diferencia entre Web 1.0, Web 2.0 y Web 3.0? ¿Cuáles son algunos ejemplos?
- Cómo desarrollar una aplicación web usando React.js que tenga un sistema de inicio de sesión
- ¿Existe una aplicación para cambiar manualmente el orden de las personas que sigues en Twitter?
- He estado creando una aplicación web durante los últimos 2 años. ¿Debo pasar a mi nueva idea?
El producto es ScreenSteps Live. Puedes aprender más acerca de esto aquí:
http://screenstepslive.com
