Appropedia:Content guidelines/es
Appropedia permite diversos tipos de contenido, siempre que se ajusten a la visión y la misión . Esta página describe los tipos más comunes y sus usos.
_(19889547733).jpg)
Appropedia no es una enciclopedia, sino un compendio de conocimientos para resolver problemas planetarios, mayoritariamente desde una perspectiva centrada en el ser humano: pobreza, cambio climático, conservación, salud, educación, etc. Appropedia se centra mayoritariamente en el conocimiento abierto , lo que significa que el conocimiento documentado intenta ayudar a las personas y organizaciones a comprender, estudiar y reproducir acciones, para crear un efecto en su entorno inmediato.
Longitud de la página
Las páginas de menos de 1000 caracteres generalmente se consideran demasiado cortas y se clasifican como esbozos . Estos esbozos necesitan ser ampliados, pero los buenos esbozos siguen siendo valiosos. Pueden contener una buena definición, una o más ideas clave o un enlace muy valioso.
Por el contrario, las páginas de más de 100.000 caracteres suelen considerarse demasiado largas. Estas páginas deben resumirse o dividirse en dos o más páginas. Una forma eficiente de hacerlo es trasladar la sección más extensa a una página independiente, redactar una buena introducción y dejar un extracto .
Secciones
- Evite las secciones de nivel 1 (con un solo signo =). El nivel 1 debe reservarse únicamente para el título de la página.
- Evite las secciones de nivel 5 o 6 (con 5 o 6 signos =). Las secciones demasiado anidadas suelen ser confusas. Reestructure el contenido para evitarlas o traslade la sección completa a una nueva página y deje un extracto .
Liza
- Evite anidar listas de más de dos niveles. Pueden ser confusas y no se ven bien en dispositivos móviles.
- Utilice listas ordenadas solo cuando el orden de los elementos sea importante, por ejemplo, al dar instrucciones paso a paso. En caso contrario, utilice listas desordenadas.
Tipos de contenido
Appropedia también puede describirse como una biblioteca de conocimientos técnicos y, como tal, es variada y se utiliza de distintas maneras. A continuación, se presentan algunos de los tipos de páginas más comunes en Appropedia y cómo encontrarlas.
Páginas temáticas
Las páginas temáticas o de conocimiento suelen estar diseñadas para ayudar a los lectores a ampliar sus conocimientos sobre un tema específico. Pueden transmitir conocimientos, pero no son artículos enciclopédicos. Deben incluir lo siguiente:
- Una descripción general de un concepto, tecnología, habilidad o procedimiento.
- Un punto de partida para introducir los conceptos generales de un tema, subdivisiones y otras consideraciones.
- Listados de ejemplos y casos más comunes en la literatura, incluyendo casos en Appropedia que pueden servir para guiar la investigación sobre el tema o la selección de una tecnología a replicar.
Los lectores pueden utilizar una página de temas como un recurso útil para explorar la variedad de casos de uso y experiencias documentadas en Appropedia sobre una tecnología o un procedimiento.
Estructura
Compruebe que una página de tema (o de conocimiento) cumple con los siguientes criterios:
- Todas las páginas de temas deben contener el cuadro de datos Plantilla: Datos de página.
- Descripción general (describa el tema)
- Instancias en Appropedia (lista de ejemplos en Appropedia). Para dispositivos y proyectos, puede usar la plantilla "Search" para mostrar una galería.
Pautas
Para crear una página de tema estelar, considere lo siguiente:
- Consideraciones técnicas como su construcción, alternativas y dificultades asociadas a su uso.
- Consideraciones culturales
- Consideraciones medioambientales.
- Fuentes de documentación externa.
Algunas de las mejores prácticas para escribir un artículo basado en conocimientos son:
- Apunte a la brevedad: los usuarios buscan una respuesta simple, no un poema;
- facilita la lectura: divide bloques largos de texto agregando listas, títulos y gráficos;
- añadir recursos: a veces, una foto, un vídeo o un enlace resultan ser una respuesta más rápida (considere utilizar contenido de Wikimedia Commons);
- Probar y optimizar: reformular el contenido en función de los comentarios de los usuarios hasta que haya una disminución en el número de preguntas.
Revisiones de literatura
Las revisiones bibliográficas resumen las fuentes y los comentarios sobre un tema. En Appropedia, suelen estar relacionadas con un proyecto específico que busca desarrollar o implementar un método o tecnología específicos. A pesar de ser documentos bastante personales (y confusos) creados durante la investigación, documentar el proceso de investigación es un recurso muy valioso para que futuros investigadores encuentren bibliografía relevante y comprendan el razonamiento detrás de las decisiones de diseño de un proyecto. Sirven como un recurso invaluable para comprender el razonamiento detrás de un proyecto o diseño específico y generar información verificable que pueda reutilizarse en el futuro.
Las revisiones bibliográficas son la base de la investigación de los appropedianos. Implican la búsqueda de fuentes como artículos, patentes y otra información de segunda mano. Aquí es donde los investigadores demuestran su conocimiento del tema que investigan. Una revisión bibliográfica es una discusión del material existente en el área temática. Por lo tanto, requiere una recopilación de trabajos publicados (impresos o en línea) relacionados con el área de investigación seleccionada.
Estructura
Las revisiones de literatura que forman parte de una página de proyecto o dispositivo deben colocarse como una subpágina, por ejemplo, en Máscaras de bricolaje/revisión de literatura .
- Plantilla:Datos de página con parámetro tipo=Revisión de literatura.
- Lista de fuentes y referencias.
Pautas
La preparación de una revisión de la literatura incluye varios pasos que pueden resumirse en tres fases que se describen a continuación:
- 1ª fase - Elaboración de una revisión de la literatura
- Elige el tema, define el problema y formula la pregunta.
- Identifique y seleccione los elementos a incluir.
- Seleccione el modelo de cita
- Organice los elementos incluidos.
- Tablas resumen de extracción de datos para análisis.
- Desarrollo de un mapa conceptual
- 2ª fase - Redactar la revisión
- Introducción.
- Cuerpo central de la revisión.
- Conclusiones.
- Citas y referencias
- 3ª fase - Verificar la revisión
- Revisión de contenido
- Escribe la reseña con buen estilo.
Consulte la categoría: MOST revisiones de literatura para obtener una guía sobre cómo hacer revisiones de literatura.
Dispositivos y proyectos
Estas páginas suelen describir un caso específico de implementación técnica, ya sea mediante el diseño o la construcción de un dispositivo específico, o mediante la implementación de un proyecto en un entorno específico. Para comprender la diferencia entre ambas categorías, es importante destacar que, si bien muchos proyectos en Appropedia implican la construcción de un dispositivo, no lo requieren, ya que pueden utilizar métodos y técnicas sociales o ambientales. Los posibles casos de uso son:
- Páginas de proyectos que no requieren la construcción de un dispositivo. Algunos ejemplos son proyectos comunitarios (proyectos de limpieza, activismo), proyectos de respuesta y socorro ante desastres, y otros que involucran principalmente a personas, utilizando herramientas y tecnología como recurso secundario.
- Páginas de proyectos que involucran la construcción e implementación de dispositivos. Un ejemplo sería el estudio de cómo se construyeron y usaron las estufas cohete en una comunidad.
- Páginas del dispositivo que contienen la lista de materiales, instrucciones de montaje y otros recursos necesarios para replicarlo.
Estructura
- Plantilla:Datos del proyecto para describir el contexto en el que se construyó el dispositivo.
- Plantilla:Datos del dispositivo con referencias a sus fichas técnicas y otros recursos para reproducir.
- Plantilla:Datos de la página con una descripción de los autores de la documentación.
Documentación básica
- Descripción general
- Fotografía del dispositivo terminado
- Lista de materiales
- Instrucciones de montaje
- Archivos descargables.
Pautas
- Consideraciones regionales: como el clima, la ubicación de las materias primas, etc., así como el contexto cultural, social y político.
- Lista de materiales: una lista de materiales, cantidades y costos necesarios para replicar un dispositivo.
- Etiquetado de estado: En las páginas de proyecto, es importante indicar el estado. Con frecuencia, el coste de inversión para recrear o desarrollar una tecnología adecuada es elevado. Además, se requiere un historial de implementación exitoso antes de invertir tiempo y recursos en una innovación. Siguiendo las instrucciones de la página Appropedia:Status , se puede mostrar fácilmente el estado de una tecnología adecuada específica para ayudar a los usuarios a decidir sobre el uso de un dispositivo o si se requiere más trabajo antes de la implementación. Consulte Appropedia:Status para obtener más información.
- Instrucciones de montaje: Debe haber información y esquemas adecuados para que el usuario confíe en que se ha realizado la debida diligencia en un diseño determinado y que el dispositivo diseñado funcionará según las especificaciones. Por ejemplo:
- Secciones sencillas con instrucciones para construir o utilizar una tecnología o material
- Nombre del producto y descripción general del dispositivo, su uso previsto y usuarios previstos.
- ¿Cómo funciona el dispositivo? ¿Está probado?
- Si se va a utilizar en combinación con otros dispositivos, describa cómo.
- Descripción general de los elementos funcionales, por ejemplo componentes (software, si corresponde).
- Incluir representaciones visuales (fotografías, dibujos, diagramas, etc.), indicando claramente los componentes y explicaciones para una mejor comprensión del material visual.
- Especificaciones técnicas como dimensiones, etc.
- El contenido más efectivo de una organización es el visual. Por ello, se recomienda utilizar material visual para comunicar la documentación. Recomendamos consultar las mejores prácticas de OSHWA . Consulte la lista de dispositivos en Appropedia aquí: Categoría: Dispositivos.
Páginas portadas
Estructura
- Marcar el material original como transferido desde
- Verifica licencias y permisos de derechos de autor: Antes de querer publicar una foto, un artículo, etc. necesitas verificar qué puedes compartir, reutilizar o copiar con una licencia que sea compatible con las permitidas en Appropedia .
- Recomendamos editar el contenido para que se ajuste al formato de Appropedia. Esto facilitará su reutilización.
Pautas
- Puede cargar imágenes o documentos sin procesar. Sin embargo, un escáner no puede hacer lo que hace un software de OCR; no basta con extraer la información relevante y transformarla a formato Word para su edición. De hecho, solo puede crear una imagen del documento, que no es más que un conjunto de puntos blancos y negros o de color ( gráficos rasterizados ). La tecnología de OCR reconoce los caracteres presentes en la imagen y los transforma en palabras para su edición.
- Recomendamos portar mediante tecnología de reconocimiento óptico de caracteres (OCR). Esto permite transformar diferentes tipos de documentos, como fotos digitales o archivos PDF, en textos editables de forma muy rápida y, sobre todo, sin esfuerzo.
Páginas de habilidades
Las páginas de habilidades describen y ejemplifican cómo hacer algo. Muestran una serie de pasos que otros pueden aprender mediante texto o video. Esto se refiere a todos los tutoriales y guías prácticas que buscan transferir conocimientos en diferentes ámbitos, como la educación y el desarrollo internacional. El contenido basado en habilidades puede adoptar diversas formas en Appropedia, por ejemplo, informes técnicos (publicados por) y libros (bibliografía adaptada).
Estructura
- Datos de la página
- Datos del curso
- Vídeo con anotaciones
Pautas
- Haz que los vídeos sean lo más cortos posible.
- Acompañe todo el contenido multimedia con instrucciones basadas en texto para garantizar la portabilidad a otros formatos y la accesibilidad para personas sin buen ancho de banda, pantallas pequeñas, así como barreras visuales o lingüísticas.
Páginas del curso
Estos contienen colecciones de páginas organizadas en módulos de aprendizaje.
Estructura
- Datos de navegación
- Datos del curso
- Datos de la página
- Programa de estudios
Enlaces externos
Appropedia acepta enlaces externos adecuados, incluso comerciales. Los enlaces adecuados son aquellos que se centran en el diseño y la información técnica directamente relevante para la página, en lugar de en la promoción de un producto u organización.
Elaboración de documentación
Appropedia cuenta con un conjunto de herramientas y tipos de página que permiten describir diversos elementos, formas de construirlos y experiencias. Están diseñados para adaptarse a diferentes tipos de proyectos y garantizar su reproducibilidad y apertura , enseñando a otros los conocimientos y habilidades necesarios para comprenderlos, adaptarlos y ejecutarlos.
La documentación es útil para diversas situaciones y procesos, por ejemplo: generar ideas y mapearlas, diseñar un dispositivo, ejecutar un proyecto o investigar. La comunidad de Appropedians documenta experiencias reales utilizando los tipos de página más comunes o combinándolos. Por ejemplo, una organización sin fines de lucro que busca cocrear un nuevo tipo de estufa cohete para una comunidad podría investigar soluciones previas mediante una revisión bibliográfica, probar diseños y documentar sus archivos de diseño e instrucciones de ensamblaje en una página del dispositivo, documentar el desarrollo de la construcción en una página del proyecto y crear una lista de instrucciones paso a paso en una página de habilidades. Esperamos que Appropedia pueda cumplir con todos estos propósitos.
Por este motivo, hemos considerado la tipología de documentación hardware, que considera elementos como instrucciones, ficheros de diseño, [ 1 ] [ 2 ] así como de otros tipos de proyectos como los presentes en la documentación de desarrollo internacional.
Estas pautas se aplican únicamente al espacio de nombres principal (a menos que se especifique lo contrario en la directriz).
Véase también
- Ayuda:Tipos de contenido
- Appropedia:Toolbox contiene una descripción de las herramientas que se pueden combinar para crear diferentes tipos de documentación.
Referencias
- ↑ Bonvoisin, J., y Mies, R. (2018). Medición de la apertura en hardware de código abierto con el Open-o-Meter. Procedia CIRP, 78, 388–393. https://doi.org/10.1016/j.procir.2018.08.306
- ↑ Proceso de Certificación OSHWA. (sin fecha). Consultado el 16 de junio de 2021 en https://certification.oshwa.org/process.html
