Saltar al contenido
BigTree108

Servicios de redacción técnica

Servicios de redacción técnica para empresas de software: referencias de API, guías para desarrolladores, documentación de usuario, runbooks y notas de versión, escritos como código junto al producto y mantenidos al día con cada versión.

Qué hacen nuestros redactores técnicos

  • Documentación de API

    Referencia generada a partir de su esquema OpenAPI o GraphQL, con guías de primeros pasos, recorridos de autenticación y ejemplos ejecutables escritos a su alrededor, para que la referencia nunca se edite a mano.

  • Docs as code

    Documentación en Markdown en su repositorio, revisada en pull requests como el código y publicada con Docusaurus, Starlight o un generador similar mediante el mismo pipeline que el producto.

  • Guías de usuario y centros de ayuda

    Guías por tareas y artículos de centros de ayuda organizados según lo que el lector intenta hacer, divididos en tutoriales, guías prácticas, referencia y explicación según el framework Diátaxis.

  • Runbooks y guías de operaciones

    Procedimientos paso a paso para despliegues, restauraciones, respuesta a incidentes y guardias, probados por alguien que no los escribió.

  • Notas de versión y changelogs

    Notas de versión que cuentan a los usuarios qué ha cambiado para ellos, y changelogs para integradores, redactados a partir de las pull requests fusionadas y contrastados con la versión.

  • Comprobaciones de estilo y calidad

    Una guía de estilo y un glosario de terminología aplicados con Vale en el pipeline, con comprobación de enlaces rotos en cada build, de modo que la coherencia no dependa de un solo revisor.

Contrate redactores técnicos

  • A tiempo completo en su equipo

    Redactores técnicos que trabajan en su horario, con sus herramientas y reuniones, y responden ante su responsable, con el contrato ucraniano, la nómina y las vacaciones de nuestro lado.

  • A tiempo parcial o fraccionado

    Redactores técnicos durante un número fijo de días a la semana, cuando el trabajo es real pero aún no justifica un puesto a tiempo completo.

  • Para un proyecto o un lanzamiento

    Redactores técnicos para un tramo de trabajo definido, desde la primera semana hasta el traspaso, con la fecha de finalización acordada de antemano.

La página de equipo dedicado explica cómo se incorporan los especialistas a su equipo, y la de outsourcing trata de la entrega de proyectos, los relevos y cómo cobramos.

Con quién trabajan nuestros redactores técnicos

  • Ingenieros y líderes técnicos

    Entrevistas, revisiones y exactitud técnica

  • Product managers

    Funcionalidades, audiencias y alcance de las versiones

  • Ingenieros de soporte

    Las preguntas que los usuarios hacen de verdad

  • Diseñadores de UI y UX

    Textos de la interfaz y diagramas

Cómo trabajan nuestros redactores técnicos

La documentación vive donde vive el código: en el repositorio, revisada en la misma pull request que el cambio que describe, y compilada y publicada por el pipeline. Una funcionalidad está terminada cuando su documentación se ha integrado, lo que mantiene la documentación tan actualizada como el código.

La redacción parte del lector: quién es, qué intenta hacer y qué sabe ya. Los tickets de soporte y los términos de búsqueda muestran dónde falla la documentación actual, y esas páginas se corrigen primero.

Otros roles que cubrimos

Resumen de Roles del equipo

Preguntas sobre la contratación de redactores técnicos

¿Puede un redactor técnico documentar un sistema que nadie ha documentado?

Sí. El redactor lee el código y la configuración, entrevista a los ingenieros y elabora una visión general de la arquitectura, runbooks y un glosario, revisados por las personas que operan el sistema. Es el mismo primer paso de solo lectura con el que empiezan nuestros relevos de sistemas heredados.

¿Cómo mantienen la documentación de la API alineada con la API?

La referencia se genera en la build a partir del esquema OpenAPI o GraphQL, por lo que no puede desviarse de la API. El redactor añade lo que un generador no puede: la guía de inicio, el recorrido de autenticación y los ejemplos que un desarrollador necesita antes de que la referencia le resulte útil.

¿Con qué rapidez pueden empezar redactores técnicos?

Cuando el redactor técnico adecuado está disponible, el inicio solo depende de su entrevista, del NDA y de la cesión de propiedad intelectual. Si no, hacemos una búsqueda, que normalmente aporta perfiles de candidatos en dos o tres semanas, y nadie empieza hasta que usted haya dicho que sí.

¿Cómo contratamos redactores técnicos a través de BigTree108?

Cuéntenos el trabajo, la seniority y las horas que necesita. Le proponemos una o dos personas con sus perfiles, usted las entrevista como entrevistaría a un empleado propio, firma un único contrato con BIG TREE 108 LLC y recibe una factura al mes.

¿Quién es el propietario del trabajo que realizan?

Usted. Cada especialista tiene un contrato firmado con BigTree108 que cede todo el producto de su trabajo a la empresa, y nuestro contrato con usted lo cede a su vez. El código, los diseños y los documentos se entregan en sus propios repositorios y herramientas, no se guardan donde solo nosotros podamos modificarlos.

¿Su documentación va por detrás del producto?

Cuéntenos el producto, sus lectores y dónde está ahora la documentación. Recibirá una respuesta en un plazo de un día laborable: perfiles de candidatos o un plan de documentación.