Ver el código de «Documentación»

__toc__{{cen1|Documentación}}
{{cen2|Registrar, ordenar y conservar información para que el conocimiento no se pierda}}

----
== Definición ==

La {{a3|documentación}} es el acto de registrar, organizar y conservar información importante para que pueda ser consultada, entendida, corregida, compartida y utilizada después.

Documentar no es solamente guardar datos. Es darles forma, contexto, fecha, fuente, explicación y utilidad. Una buena documentación permite que una persona, familia, escuela, proyecto o comunidad no dependa únicamente de la memoria mental.

{{nota|Idea central|La documentación convierte lo vivido, aprendido o descubierto en memoria organizada. Lo que se documenta puede volver a estudiarse, mejorarse y transmitirse.}}

----

== Diferencia entre guardar y documentar ==

{| class="wikitable" style="width:57%; margin:auto; text-align:left;"
! style="background:#C8E6C9;" | Acción
! style="background:#C8E6C9;" | Significado
! style="background:#C8E6C9;" | Ejemplo
|-
| Guardar
| Conservar algo sin necesariamente explicarlo.
| Tener una foto, un archivo, un enlace o una nota suelta.
|-
| Documentar
| Guardar con contexto, estructura y propósito.
| Crear una página con fecha, fuente, descripción, análisis, categorías y enlaces.
|}

{{nota|Punto clave|Guardar puede evitar una pérdida inmediata. Documentar permite entender, encontrar y reutilizar la información en el futuro.}}

----

== Descripción general ==

La documentación es una herramienta de claridad. Ayuda a que una idea no se pierda, que un procedimiento pueda repetirse, que una fuente pueda verificarse y que una experiencia se transforme en aprendizaje.

Dentro de {{a3|WikiFSF}}, la documentación cumple una función central: convertir videos, imágenes, recetas, reflexiones, errores técnicos, procedimientos, memorias familiares y aprendizajes en páginas útiles, ordenadas y conectadas.

Una documentación bien hecha responde preguntas básicas:

* ¿Qué es esto?
* ¿De dónde salió?
* ¿Cuándo se registró?
* ¿Quién lo explicó o curó?
* ¿Para qué sirve?
* ¿Cómo se usa?
* ¿Qué advertencias tiene?
* ¿Con qué otros temas se conecta?

----

== Funciones principales de la documentación ==

{| class="wikitable" style="width:95%; margin:auto; text-align:left;"
! style="background:#BBDEFB;" | Función
! style="background:#BBDEFB;" | Qué permite
! style="background:#BBDEFB;" | Ejemplo WikiFSF
|-
| Conservar
| Evitar que una información se pierda.
| Guardar la URL de un video, imagen o fuente.
|-
| Explicar
| Hacer entendible un contenido.
| Resumen, definición, procedimiento o tabla.
|-
| Ordenar
| Dar estructura a datos dispersos.
| Secciones, subtítulos, tablas y categorías.
|-
| Verificar
| Registrar fuentes y contexto.
| Canal, fecha, enlace, descripción original.
|-
| Enseñar
| Convertir información en aprendizaje.
| Guías paso a paso, ejemplos y notas.
|-
| Recordar
| Recuperar información después.
| Artículos consultables por título y categoría.
|-
| Mejorar
| Permitir correcciones futuras.
| Versiones, ajustes, notas y ampliaciones.
|-
| Transmitir
| Compartir conocimiento con otros.
| Página WikiFSF clara y reutilizable.
|}

----

== Tipos de documentación ==

{| class="wikitable" style="width:95%; margin:auto; text-align:left;"
! style="background:#D1C4E9;" | Tipo
! style="background:#D1C4E9;" | Qué registra
! style="background:#D1C4E9;" | Ejemplo
|-
| Documentación técnica
| Procedimientos, código, errores, configuraciones.
| Plantillas MediaWiki, scripts, bugs, soluciones.
|-
| Documentación educativa
| Explicaciones para aprender un tema.
| Artículos sobre nutrición, memoria, descanso o salud intestinal.
|-
| Documentación familiar
| Recetas, historias, fotografías, objetos, acuerdos.
| Página sobre comida familiar o memoria del hogar.
|-
| Documentación visual
| Imágenes, capturas, fotos, ilustraciones.
| Imagen con URL, descripción, contexto y categoría.
|-
| Documentación de videos
| URL, canal, descripción, resumen y aprendizajes.
| Página sobre receta, documental o reflexión.
|-
| Documentación de proyectos
| Ideas, avances, decisiones, pendientes.
| Escuela RyE, 5Era, Lumen, WikiFSF.
|-
| Documentación espiritual
| Oraciones, reflexiones, símbolos y mensajes.
| Artículos de oración, límites, cierre de ciclos.
|-
| Documentación de salud
| Resúmenes, advertencias, hábitos y observaciones.
| Artículos sobre fibra, colitis, sueño, alimentación.
|}

----

== Elementos básicos de una buena documentación ==

{| class="wikitable" style="width:95%; margin:auto; text-align:left;"
! style="background:#FFE0B2;" | Elemento
! style="background:#FFE0B2;" | Función
! style="background:#FFE0B2;" | Ejemplo
|-
| Título
| Nombra claramente el tema.
| {{cen1|Documentación}}
|-
| Subtítulo
| Da dirección y tono.
| {{cen2|Registrar, ordenar y conservar información}}
|-
| Fecha
| Ubica el registro en el tiempo.
| 2026-06-22.
|-
| Fuente
| Permite rastrear el origen.
| URL, canal, libro, imagen, testimonio.
|-
| Descripción
| Explica de qué trata.
| Resumen general del contenido.
|-
| Contexto
| Indica por qué importa.
| Uso familiar, educativo, técnico o espiritual.
|-
| Procedimiento
| Enseña cómo usar o repetir.
| Pasos numerados.
|-
| Advertencias
| Señala riesgos o límites.
| Precauciones de salud, legales o técnicas.
|-
| Categorías
| Conectan el artículo con el sistema.
| [[CATEGORY:DOCUMENTACION]]
|-
| Créditos
| Reconocen autoría, fuente y curaduría.
| {{Chat|GPT-5.5 Thinking - 2026-06-22}}
|}

{{nota|Documentar con contexto|Una URL sola puede perder sentido. Una URL con título, fecha, fuente, descripción, resumen y reflexión se convierte en memoria útil.}}

----

== Documentación dentro de WikiFSF ==

WikiFSF puede funcionar como un sistema de documentación vivo. Cada página puede convertirse en una estación de memoria, aprendizaje y consulta.

{| class="wikitable" style="width:95%; margin:auto; text-align:left;"
! style="background:#F8BBD0;" | Recurso WikiFSF
! style="background:#F8BBD0;" | Función documental
! style="background:#F8BBD0;" | Uso práctico
|-
| Artículos
| Desarrollan un tema.
| Página sobre [[Nutrición]], [[Hogar]] o [[Memoria]].
|-
| Categorías
| Agrupan páginas relacionadas.
| [[CATEGORY:SALUD]], [[CATEGORY:HOGAR]], [[CATEGORY:RECETAS]].
|-
| Plantillas
| Estandarizan formato.
| {{nota}}, {{Fuente}}, {{Chat}}, {{cen1}}, {{cen2}}.
|-
| Tablas
| Ordenan información compleja.
| Comparaciones, pasos, ventajas, riesgos.
|-
| Enlaces internos
| Conectan conceptos.
| [[Alimentación]] con [[Nutrición]] y [[Despensa]].
|-
| Enlaces externos
| Conservan fuentes originales.
| Videos, canales, imágenes, artículos.
|-
| Créditos
| Reconocen autoría y curaduría.
| Fuente original y adaptación WikiFSF.
|-
| Notas destacadas
| Señalan ideas centrales.
| {{nota|Idea central|Texto importante.}}
|}

----

== Documentación de videos ==

Cuando se documenta un video, conviene conservar el origen y también crear una interpretación útil.

{| class="wikitable" style="width:95%; margin:auto;"
! style="background:#B2DFDB;" | Elemento
! style="background:#B2DFDB;" | Qué registrar
! style="background:#B2DFDB;" | Ejemplo
|-
| URL
| Enlace directo al video.
| https://youtu.be/...
|-
| Canal
| Autor o fuente original.
| {{Fuente|Nombre del canal|URL del canal}}
|-
| Fecha de publicación
| Cuándo fue publicado.
| 9 de febrero de 2023.
|-
| Descripción original
| Texto compartido por el canal.
| Ingredientes, contexto, advertencias.
|-
| Resumen
| Explicación breve del contenido.
| Qué enseña el video.
|-
| Procedimiento
| Pasos prácticos.
| Receta, técnica, método o guía.
|-
| Reflexión WikiFSF
| Valor educativo o familiar.
| Qué se puede aprender y conservar.
|-
| Créditos
| Reconocimiento de fuente y curaduría.
| Canal original + {{Chat|GPT-5.5 Thinking - 2026-06-22}}.
|}

{{nota|Respeto a la fuente|Documentar no significa apropiarse del trabajo ajeno. Una buena página debe reconocer al canal, conservar el enlace y diferenciar entre fuente original y curaduría WikiFSF.}}

----

== Documentación de imágenes ==

Una imagen puede documentarse como evidencia, símbolo, memoria o recurso visual.

{| class="wikitable" style="width:95%; margin:auto; text-align:left;"
! style="background:#DCEDC8;" | Elemento
! style="background:#DCEDC8;" | Qué registrar
! style="background:#DCEDC8;" | Para qué sirve
|-
| URL de imagen
| Enlace original o ubicación.
| Permite rastrear el recurso.
|-
| Descripción visual
| Qué aparece en la imagen.
| Facilita búsqueda y comprensión.
|-
| Texto visible
| Frases o mensajes que contiene.
| Conserva contenido escrito.
|-
| Contexto
| Por qué se guarda.
| Artículo, reflexión, memoria familiar.
|-
| Uso sugerido
| Cómo se puede emplear.
| Portada, alegoría, ficha, documentación.
|-
| Categorías
| Dónde se archiva.
| Imagen, artículo, salud, hogar, espiritualidad.
|-
| Fuente
| Autor, canal, sitio o procedencia si se conoce.
| Respeta atribución.
|}

----

== Documentación técnica ==

La documentación técnica permite repetir soluciones y evitar que un error tenga que resolverse desde cero cada vez.

{| class="wikitable" style="width:95%; margin:auto; text-align:left;"
! style="background:#C5CAE9;" | Elemento técnico
! style="background:#C5CAE9;" | Qué documentar
! style="background:#C5CAE9;" | Ejemplo
|-
| Problema
| Qué falló.
| Plantilla que se muestra mal.
|-
| Contexto
| Dónde ocurrió.
| WikiFSF, MediaWiki, plantilla específica.
|-
| Código original
| Versión antes del ajuste.
| Bloque de código.
|-
| Corrección
| Cambio realizado.
| Ancho de tabla, parámetro, CSS.
|-
| Resultado
| Qué mejoró.
| Respeta el TOC, no choca con tablas.
|-
| Advertencia
| Qué evitar.
| No usar parámetros separados si la plantilla espera uno solo.
|-
| Fecha
| Cuándo se corrigió.
| 2026-06-22.
|}

{{nota|Memoria técnica|Un bug resuelto sin documentación puede regresar. Un bug documentado se convierte en conocimiento reutilizable.}}

----

== Documentación familiar ==

La familia produce conocimiento todos los días: recetas, remedios, hábitos, advertencias, historias, gastos, acuerdos, fotografías y aprendizajes.

{| class="wikitable" style="width:95%; margin:auto; text-align:left;"
! style="background:#FFECB3;" | Tema familiar
! style="background:#FFECB3;" | Qué documentar
! style="background:#FFECB3;" | Valor
|-
| Recetas
| Ingredientes, pasos, fuente, variaciones.
| Conserva sabor y memoria.
|-
| Salud
| Síntomas, medicamentos, consultas, advertencias.
| Evita olvidar datos importantes.
|-
| Economía
| Gastos, deudas, ahorro, compras.
| Da claridad familiar.
|-
| Hogar
| Reparaciones, herramientas, mantenimiento.
| Facilita cuidado de la casa.
|-
| Fotos
| Fecha, personas, lugar, significado.
| Protege memoria familiar.
|-
| Historias
| Relatos de vida, aprendizajes, anécdotas.
| Transmite identidad.
|-
| Acuerdos
| Responsabilidades y decisiones.
| Reduce conflictos.
|}

----

== Documentación como aprendizaje ==

Documentar ayuda a aprender porque obliga a ordenar. Para explicar algo, primero hay que entenderlo mejor.

{| class="wikitable" style="width:95%; margin:auto;"
! style="background:#E1BEE7;" | Proceso
! style="background:#E1BEE7;" | Qué ocurre
! style="background:#E1BEE7;" | Resultado
|-
| Observar
| Se mira el contenido o experiencia.
| Aparece información inicial.
|-
| Seleccionar
| Se decide qué importa.
| Se reduce ruido.
|-
| Ordenar
| Se crean secciones, tablas y pasos.
| La información se vuelve clara.
|-
| Explicar
| Se redacta en lenguaje útil.
| Otros pueden entender.
|-
| Relacionar
| Se conecta con otros temas.
| Aparece mapa de conocimiento.
|-
| Revisar
| Se corrige y mejora.
| La memoria se mantiene viva.
|-
| Compartir
| Se publica o transmite.
| El conocimiento sale del aislamiento.
|}

----

== Buenas prácticas de documentación ==

{| class="wikitable" style="width:95%; margin:auto;"
! style="background:#FFF59D;" | Práctica
! style="background:#FFF59D;" | Beneficio
! style="background:#FFF59D;" | Ejemplo
|-
| Fechar
| Ubica el contenido en el tiempo.
| 2026-06-22.
|-
| Citar fuente
| Da trazabilidad.
| Canal, URL, autor, libro, imagen.
|-
| Separar fuente y curaduría
| Evita confusión de autoría.
| Fuente original + adaptación WikiFSF.
|-
| Usar títulos claros
| Facilita búsqueda.
| [[Cocina económica]], [[Memoria]], [[Despensa]].
|-
| Crear tablas
| Ordena información.
| Ventajas, pasos, errores, tipos.
|-
| Agregar notas
| Resalta ideas clave.
| {{nota|Punto clave|Texto.}}
|-
| Categorizar
| Conecta con el archivo general.
| [[CATEGORY:DOCUMENTACION]]
|-
| Usar enlaces internos
| Teje conocimiento.
| [[Organización]], [[Memoria]], [[WikiFSF]].
|-
| Revisar
| Corrige errores y mejora utilidad.
| Ajustar plantilla, estilo o contenido.
|-
| Respaldar
| Protege el trabajo.
| Exportar, copiar, guardar versión local.
|}

----

== Errores comunes al documentar ==

{| class="wikitable" style="width:95%; margin:auto; text-align:left;"
! style="background:#FFCDD2;" | Error
! style="background:#FFCDD2;" | Consecuencia
! style="background:#FFCDD2;" | Corrección
|-
| No poner fuente
| Se pierde origen y credibilidad.
| Registrar URL, autor o contexto.
|-
| No poner fecha
| No se sabe cuándo fue válido.
| Fechar la documentación.
|-
| Copiar sin explicar
| El contenido queda poco útil.
| Añadir resumen, contexto y reflexión.
|-
| Documentar sin categorías
| Luego es difícil encontrar.
| Agregar categorías relevantes.
|-
| Guardar demasiado sin ordenar
| La memoria se vuelve bodega.
| Usar secciones y tablas.
|-
| No diferenciar autoría
| Puede parecer apropiación.
| Separar fuente original de curaduría.
|-
| Hacerlo demasiado complejo
| Se abandona el hábito.
| Usar una estructura simple y repetible.
|-
| No corregir
| Errores se repiten.
| Revisar y actualizar.
|}

----

== Estructura sugerida para WikiFSF ==

Una página documental sencilla puede usar esta estructura base:

{| class="wikitable" style="width:95%; margin:auto;"
! style="background:#D7CCC8;" | Sección
! style="background:#D7CCC8;" | Función
|-
| Título y subtítulo
| Presentan el tema.
|-
| Fuente
| Reconoce origen.
|-
| Descripción general
| Explica de qué trata.
|-
| Tabla principal
| Ordena datos clave.
|-
| Procedimiento o análisis
| Enseña cómo usar la información.
|-
| Advertencias
| Evita malentendidos o riesgos.
|-
| Reflexión WikiFSF
| Da sentido humano, educativo o familiar.
|-
| Créditos
| Reconoce curaduría y autoría.
|-
| Véase también
| Conecta con otros artículos.
|-
| Categorías
| Integra al sistema.
|}

----

== Documentación como práctica de futuro ==

La documentación prepara el futuro porque evita que cada generación, cada proyecto o cada persona tenga que empezar de cero.

{| class="wikitable" style="width:95%; margin:auto;"
! style="background:#BBDEFB;" | Acción presente
! style="background:#BBDEFB;" | Posible efecto futuro
|-
| Documentar una receta
| La familia puede repetirla y conservarla.
|-
| Guardar una fuente
| Se puede verificar después.
|-
| Escribir un procedimiento
| Otros pueden repetirlo.
|-
| Registrar un error
| Se evita cometerlo otra vez.
|-
| Crear categorías
| El conocimiento se encuentra más fácil.
|-
| Respaldar archivos
| El trabajo no desaparece por falla técnica.
|-
| Dar créditos
| Se conserva ética y respeto.
|}

----

== Ficha rápida ==

{| class="wikitable" style="width:70%; margin:auto;"
! style="background:#E0E0E0;" | Dato
! style="background:#E0E0E0;" | Información
|-
| Palabra
| Documentación
|-
| Área
| Memoria, educación, archivo, proyectos y organización
|-
| Función principal
| Registrar, ordenar y conservar información útil
|-
| Herramientas
| Texto, tablas, fuentes, fechas, categorías, enlaces y respaldos
|-
| Virtud central
| Claridad
|-
| Riesgo común
| Guardar sin contexto ni orden
|-
| Enfoque WikiFSF
| Convertir información dispersa en memoria viva y aprendizaje compartible
|}

----

== Reflexión WikiFSF ==

La documentación es una forma de respeto por el conocimiento. Es decir: “esto importó, esto enseñó algo, esto puede servir después”.

Sin documentación, muchas ideas se pierden como humo. Con documentación, una experiencia puede convertirse en guía, una receta en tradición, un error en advertencia, una fuente en aprendizaje y una memoria en camino.

WikiFSF existe como una casa para esa documentación: no solo para acumular páginas, sino para ordenar la vida, cuidar la memoria y preparar el futuro.

{{nota|Símbolo de memoria|Documentar es encender una pequeña lámpara contra el olvido. Lo escrito con claridad puede acompañar a quien venga después.}}

----

== Créditos ==

{| class="wikitable" style="width:95%; margin:auto;"
! style="background:#E0E0E0;" | Elemento
! style="background:#E0E0E0;" | Crédito
|-
| Artículo
| Página WikiFSF sobre la palabra Documentación.
|-
| Curaduría, organización pedagógica y adaptación WikiFSF
| {{Chat|GPT-5.5 Thinking - 2026-06-22}}
|-
| Sitio de documentación
| [[WikiFSF]]
|}

----

== Véase también ==

* [[Memoria]]
* [[WikiFSF]]
* [[Organización]]
* [[Aprendizaje]]
* [[Educación]]
* [[Hogar]]
* [[Familia]]
* [[Recetas]]
* [[Plantillas]]
* [[Fuentes]]
* [[Categorías]]
* [[Archivo]]

----

[[CATEGORY:DOCUMENTACION]]
[[CATEGORY:WIKIFSF]]
[[CATEGORY:MEMORIA]]
[[CATEGORY:ORGANIZACION]]
[[CATEGORY:APRENDIZAJE]]
[[CATEGORY:EDUCACION]]
[[CATEGORY:ARCHIVO]]
[[CATEGORY:FUENTES]]
[[CATEGORY:HOGAR]]
[[CATEGORY:FAMILIA]]
[[CATEGORY:AUTORES]]