¿Qué no le gusta del software que usa para crear documentación?

Desearía que mi software de formateo de documentos estuviera más estructurado, que supiera lo que era una lista sangrada y que los hiciera todos de la misma manera. Demasiados editores quieren que toques los márgenes y el espaciado y todo eso en un nivel bajo. Está bien para una nota de 2 páginas, pero en un documento más largo, tiene problemas para hacer lo mismo de diferentes maneras. ¡Ojalá pudiera importar un nuevo formato y poof !, mi documento se veía bien. Word (por ejemplo) tiene plantillas, pero puede manipular manualmente cada párrafo. Si hace eso, la importación de una nueva plantilla arregla algunas cosas pero no otras.

Deseo que mi software de formateo de documentos genere una salida de texto sin formato en el que pueda ejecutar diff para averiguar qué cambió, poner en un administrador de revisión, etc. Los archivos con formato binario son una mierda.

Desearía poder editar código y comentarios juntos en el mismo archivo. El código y su documentación pertenecen juntos, pero los editores requieren que los mantenga separados. Desearía poder editar texto y diagramas juntos, y funcionó a la perfección. Esto requeriría que tanto mi lenguaje de programación como mi formateador de documentos reconozcan las transiciones de código a texto a diagramas. Porque el desarrollador del siguiente escritorio probablemente quiera usar un editor diferente. Un editor que entiende que un sistema de archivos contiene archivos de texto y archivos de código puede ser una respuesta efectiva, pero debe mostrar las partes relacionadas juntas.

Desearía que mi formateador de documentos pudiera generar HTML decente cuando quisiera escribir una página web, y Markdown decente cuando quisiera escribir un artículo wiki, y producir documentos en papel de alta calidad cuando quisiera eso. La composición de los mismos párrafos con el mismo marcado (cursiva, negrita, fuente, …) en diferentes formatos de salida no es la parte más difícil de escribir un editor, pero tengo que usar 15 editores diferentes en estos días porque cada uno quiere producir uno o Tal vez dos formatos.

No quiero pagar mil dólares para averiguar si un editor satisface mis necesidades. Tampoco quiero pagar cien dólares al año para usar un editor que nunca poseo, y que necesita una conexión a la web para funcionar. Idealmente, sería de código abierto para que algún geek pudiera escribir ese compositor de rebajas y ponerlo a disposición. Las empresas comerciales están demasiado enfocadas y demasiado ansiosas por segmentar el mercado. No quiero un producto segmentado. Quiero una herramienta de uso general. Todo esto no significa que no esté dispuesto a pagar por una herramienta decente. Simplemente no me gusta la sensación de ser coaccionado o retenido como rehén. Hola, gente de marketing, sabes que a los usuarios les molesta que te traten como un recurso para ser explotado en lugar de un socio, ¿verdad?

Como escribo no ficción, quiero un editor que pueda resumir documentos de texto; tiene una vista de esquema; hace que la tabla de contenido y el índice y la lista de figuras sean entradas fáciles al texto. A veces quiero centrarme en el código, a veces en los diagramas, a veces en el texto y a veces para ver todo.

Entonces, ¿cuándo puedes enviarlo?

Lo que no me gusta sobre el software que uso para crear documentación es no poder usar el mismo software para más de un tipo de documentación.

  • La documentación técnica, en mi caso, requiere la creación de reStructuredText o Markdown, y el uso de GitHub para el control de versiones.
  • La documentación no técnica, por otro lado, requiere una herramienta que todos puedan usar para la creación, como Google Docs.
  • Mientras tanto, publico publicaciones de blog a través de la interfaz web de WordPress.

La lista continua. Renunciar a cualquiera de las herramientas de software sería un gran sacrificio, por lo que termino usando media docena de herramientas de documentación diferentes casi a diario.

Dando un paso atrás, diría que lo que no me gusta de todo el software en cuestión es que generalmente no reconoce que solo representa un paso en un flujo de trabajo de publicación. El peor software de documentación intenta ser el único que necesita.

Mi equipo y mi organización más grande usan Google Drive para almacenar artefactos, notas para desarrolladores y material de incorporación. Es un desastre.

Nuestro disco compartido almacena toneladas de guías prácticas sobre nuestras prácticas, ejemplos de ejercicios que se ejecutaron con otros clientes, notas de nuestros retros, etc. Todos tienen acceso a todo, pero nadie puede encontrar nada. Además, si alguien abandona la organización, los documentos importantes y las carpetas enteras tienden a desaparecer.

No me gusta el caos que resulta del estrecho interés de los desarrolladores de herramientas de autor. Un culpable familiar es Microsoft Office, que descuida problemas fundamentales como listas anidadas poco confiables en Word mientras busca el último objeto brillante de marketing. (Sin embargo, me gusta VBA, que considero como un regalo debajo de la mesa de los desarrolladores).

More Interesting

¿Cuáles son las ventajas de trabajar como ingeniero de software en TCS?

Cómo evaluar la madurez de un equipo de ingeniería de software

Recibí una oferta de trabajo de Microsoft India, Hyderabad como Nivel 64 (Ingeniero de Software Senior). ¿Qué factores debo considerar antes de unirme?

¿Es demasiado tarde para estudiar programación y convertirme en ingeniero de software si ya estoy trabajando a tiempo completo?

¿Cuáles son los cursos esenciales que debe tomar un ingeniero de software?

Estoy trabajando como ingeniero de software en MNC en India de 7 a 8 meses, pero el conjunto de habilidades de trabajo es casi nulo. ¿Cómo prepararse para el cambio de trabajo?

Soy un chico de 25 años que trabaja como ingeniero de software. ¿Cómo puedo quitarme el culo y comenzar a tomar medidas en lugar de simplemente planear cosas?

¿Cuáles son algunas de las compañías tecnológicas más grandes para las que cualquier ingeniero de software aspiraría a trabajar?

Cómo convertirse en un programador decente sin experiencia

¿Cuál es la compensación total habitual por año para un ingeniero de software que trabaja en Google, en Silicon Valley y en Wall Street?

Tengo 5 años de experiencia en Ingeniería de Software e hice Ingeniería (ECE) en UG. Ahora descubrí que mi interés está en la arquitectura. ¿Es posible cambiar?

¿Cuáles son los conceptos básicos de ingeniería de software?

¿Cuál es el tamaño del mercado de TI de Waterloo, Ontario, Canadá? ¿Qué es un rango de pago para un ingeniero de software?

Soy un ingeniero de software de 22 años que trabaja en una empresa de TI. Después de completar todos mis gastos mensuales, ahorro 10 mil rupias por mes. ¿Dónde puedo invertirlos para tener una buena vida en el futuro?

¿Cómo son las oficinas de los equipos de Microsoft?