JetBrains lanza WriterSide, la herramienta de escritura basada en IntelliJ

Con Lado del escritor, JetBrains tiene como objetivo permitir a los desarrolladores y escritores crear documentación técnica utilizando un flujo de trabajo de escritura, prueba y compilación. La nueva herramienta se basa en los IDE de la plataforma IntelliJ y se ha utilizado para crear la mayor parte de la documentación de los productos JetBrains durante los últimos años.

Este proyecto se desarrolló a partir de cientos de entrevistas con clientes y más de 10 años de trabajo en la documentación de la plataforma IntelliJ. Estas experiencias nos brindaron una larga lista de funciones que desarrollar y problemas que resolver.

Uno de los objetivos clave de WriterSide es permitir una colaboración eficaz entre desarrolladores y escritores y cerrar la brecha entre ellos. Implica una canalización de “documento como código” basada en herramientas de desarrollo como Git, revisiones de extracción y comprobaciones automatizadas para que todo el equipo pueda contribuir, revisar y realizar un seguimiento de los cambios como están acostumbrados a hacer con el código. Esto, según JetBrains, simplifica el proceso de documentación.

WriterSide admite Markdown y un marcado personalizado basado en XML y permite a los autores combinar ambos formatos en el mismo documento. Esto permite inyectar atributos semánticos en un documento Markdown para enriquecerlo, por ejemplo. Por el contrario, WriterSide también admite la traducción de fragmentos de Markdown a XML sobre la marcha e importarlos a un documento XML.

WriterSide puede realizar más de 100 pruebas integradas, como pruebas de enlaces rotos, recursos faltantes, valores de atributos incorrectos, etc. Las pruebas se pueden personalizar según las convenciones internas de ortografía y estilo. La herramienta también ofrece diseños predefinidos que se pueden personalizar fácilmente para que los autores no tengan que lidiar con el diseño y CSS.

Dado que los autores deben escribir XML o Markdown, WriterSide incluye una función de vista previa en vivo que refleja instantáneamente cada cambio y resalta los errores. Esto es especialmente útil cuando no hay acceso a la canalización de CI/CD o para compilaciones más largas, por lo que es posible verificar el resultado sin esperar a que finalicen.

Como nota final sobre las funciones de WriterSide, proporciona un corrector ortográfico basado en IA y una corrección gramatical creada por JetBrains que admite más de 25 idiomas.

WriterSide está disponible como complemento para IDE de JetBrains y como aplicación independiente bajo un Programa de acceso temprano (PEA). El producto es completamente gratuito mientras dure el EAP, pero JetBrains prometió que tendrán una versión gratuita o un EAP continuo para permitir el uso de la herramienta de forma gratuita.