Documentación técnica
Dejarlo escrito para quien venga después
Traspasos, procedimientos operativos y manuales para que su personal pueda operar el sistema sin llamar a quien lo construyó.
Trabajos seleccionados que demuestran este servicio.

Foto: jessica45 / Pixabay 
Foto: stevepb / Pixabay
Convierta el servicio en un resultado
Haga que «Documentación técnica» contribuya a un resultado empresarial. Podemos conectar el trabajo técnico con los usuarios, las operaciones y las decisiones a los que debe dar soporte. Traspasos, procedimientos operativos y manuales para que su personal pueda operar el sistema sin llamar a quien lo construyó.
Examine los trabajos relevantes
Utilice los trabajos relacionados de esta página para examinar nuestro enfoque. Pregunte por los compromisos entre objetivos y las condiciones detrás de cada resultado. 578 tareas de automatización go‑task — 578 tareas de automatización para todas las formas de ejecución
-
578 tareas de automatización go‑task
Redacté 578 tareas de automatización go‑task para los modos de desarrollo nativo, Docker y HTTPS, así como para análisis estático, pruebas, bases de datos y despliegue.
-
Motor de 268 controles para el repositorio
Desarrollé el motor de comprobaciones del repositorio — 268 controles de commit registrados, 277 reglas de análisis estático y 15 reglas ESLint propias —, además de 146 pruebas de los propios controles, para que la compilación haga cumplir el criterio de calidad.
-
Análisis continuo de seguridad
Establecí un programa continuo de seguridad — análisis de código, DAST, comprobación de dependencias y vulnerabilidades, generación de SBOM, detección de secretos y acciones fijadas por SHA —, junto con 21 auditorías de seguridad documentadas.
-
7 roles de informes de solo lectura
Desarrollé siete roles de informes de solo lectura que representan un servidor activo en Markdown — inventario técnico, acceso, git, métricas, tráfico, seguridad e inventario de proveedores — bajo la regla de no imprimir ninguna cifra que la ejecución no haya medido.
-
Regla de alcance tras una fuga de credenciales
Incorporé al repositorio una regla de alcance tras una reorganización que había introducido el inventario, los permisos de cortafuegos y textos de otra empresa, y mantuve los residuos en cuarentena bajo el detector de secretos, sin excluirlos.
-
Control de commits con 22 analizadores
Desarrollé un control obligatorio de commits con 22 analizadores de una línea y cinco que requieren una explicación, sin nivel de advertencias ni supresiones en línea permitidas, que cubre HTML, CSS, JavaScript, Python, YAML, Markdown, Shell, enlaces, ortografía, secretos y tipografía.
-
Diferencias detectadas entre hooks y controles
Detecté que los hooks de commit y el control de calidad ejecutaban comprobaciones distintas aunque un documento prometía que eran iguales, al comparar ambas listas en una prueba: las cinco que solo se ejecutaban a mano eran las que revisaban la redacción del CV.
-
Analizador que verifica cada llamada FFI
Escribí un analizador que lee la cabecera C real de 7.308 líneas y verifica cada punto de llamada, cada constante de enumeración y que toda clase propietaria de un puntero sea final, después de que una cabecera provisional escrita a mano permitiera compilar y enlazar llamadas a tres funciones eliminadas que causaban fallos al ejecutarse.
-
Un criterio de historial para 4 repositorios
Apliqué un único criterio de historial a cuatro repositorios — commits convencionales, sin emojis ni líneas de atribución y con un hook de mensajes de commit —, junto con 48 documentos de instrucciones que regulan la forma de trabajar.
-
Seis recolectores declaran lo que omitieron
Hice que seis recolectores de informes declararan la parte de sus entradas que nunca habían leído — archivos no abiertos, sondeos no instalados y líneas del diario no reconocidas — y ajusté los umbrales a 116 muestras medidas tras constatar que una recolección ciega y un servidor sano generan la misma página.

