Writing guide

Prefacio

Se te ha seleccionado para crear contenido para una aplicación móvil diseñada para identificar distintas especies a partir de imágenes usando tecnología de inteligencia artificial (IA). Junto a la identificación, la aplicación ofrece información contrastada sobre la especie. Nuestra labor es redactar esta información.

El texto debe ser interesante y debe estar basado en la mayor cantidad de información contrastada posible. Aún así, deberemos evitar redacciones aburridas, ya que eso no hace más que dificultar el proceso de lectura.

Esta guía tiene 4 partes:

  1. Cómo hacer tu contenido completo e interesante.
  2. Cómo asegurarte de que tu contenido es fidedigno.
  3. Cómo evitar problemas políticos o legales.
  4. Otros posibles problemas con el formato y la experiencia de lectura.
1. Cómo hacer tu contenido completo e interesante.

La informatividad va a ser más importante que la retórica.

  • Tratemos de citar fuentes reputadas antes de llegar a conclusiones.
  • En general se recomienda usar información local. Para ello, podremos recurrir a páginas web españolas o latinoamericanas.
  • Si es necesaria más información, trata de buscar resultados en inglés, que según qué especie pueden ser más completos.
  • Usa una redacción simple, directa y de fácil lectura, evitando usar estereotipos y términos poco frecuentes.
  • Si es necesario mencionar un concepto de fácil comprensión en el ámbito académico pero difícil de entender para el gran público (p. ej. El ciclo de Calvin), trata de explicarlo de forma más simple (La forma en la que obtiene materia orgánica las plantas).
2. Cómo asegurarte de que tu contenido es fidedigno.

El nombre científico va a ser el único criterio a la hora de decidir de qué especie hay que hablar. En general, trataremos de escribir sobre la planta asociada a este nombre, particularmente en caso de conflictos con el nombre común. Tanto para evitar errores como para facilitar el proceso de revisión, será necesario adjuntar links a las fuentes. Se deberá añadir los links a la celda “Link”, junto con una breve explicación entre corchetes de por qué se cita.

Si marcamos en el RFP que no se debe usar una sola fuente, será necesario añadir al menos dos. Si la información de todas las fuentes solapa, no hay problema, pero si hay algún tipo de conflicto, se dará prioridad a información que proceda de organizaciones académicas o gubernamentales.

Aunque hemos avisado de forma repetida que no se debe recolectar plantas u hongos salvajes, no podemos evitar que nuestros usuarios lo hagan. Por ello, hay algunas expresiones sensibles que deben ser tratadas con particular tacto: “No tóxico”, “Comestible”, “Medicinal”. Todas estas expresiones deben ir acompañadas de una cita reputable.

Una cita reputable implica cualquier página web apoyada o sostenida por:

  • Páginas web gubernamentales [.gov]
  • Páginas web universitarias [.edu]
  • La Academia Nacional [.ac]
  • Organizaciones oficiales [.org] Nota: Wikipedia.org no se considera de fiar.
  • Artículos científicos o revisiones en revistas científicas.
  • Textos de referencia.

Si no es posible encontrar una fuente reputada para apoyar algo (aunque sea sentido común), trataremos de no hablar de ello.

Para cada expresión sensible, debemos tomar notas extre:

  • No tóxico: Si se afirma que algo no es tóxico, se debe confirmar que el ser vivo entero no es tóxico, no solo una parte. Si solo una parte no lo es, se debe especificar (La fruta no es tóxica ).
  • Comestible: Solo se debe mencionar en el caso de cultivos, frutas, vegetales y hongos comúnmente aceptados. En este caso, será necesario adjuntar un enlace a una empresa que lo comercialice, junto con el enlace a la fuente fiable donde se confirma que es comestible. No se debe confundir con empresas que lo comercialicen con fines médicos.
  • Medicinal: No se debe hablar de ningún uso médico a no ser que tenga relevancia histórica o cultural. No se deben mencionar nunca indicaciones de uso, dosis o eficacia.

Se debe comprobar con mucho cuidado que algo no es tóxico antes de afirmarlo. Si alguna etapa de la planta es tóxica, debe ser mencionado. Por ejemplo, los anacardos están cubiertos de cáscaras tóxicas.

3. Cómo evitar problemas políticos o legales.
  • El plagio está estrictamente prohibido. Todo el contenido se revisará de forma manual.
  • Contenido negativo que pueda dar lugar a debate, o aquello que mencione temas políticos, pornográficos, religiosos, raciales o relacionados con las drogas está prohibido.
  • Aunque la marihuana es legal en algunos países, al igual que algunos hongos, se evitará mencionarla.
  • El tabaco y el alcohol no se juzgan ni recomiendan. Se puede afirmar que el tequila se hace con ágave, pero no podremos hablar de si el tequila es bueno o malo.
  • Trataremos de evitar usar marcas en el contenido.
4. Otros posibles problemas con el formato y la experiencia de lectura.
  • Consistencia a la hora de usar el nombre común: El nombre común debe escribirse siempre de la misma forma. Si consideras que el nombre común que aparece en la página es incorrecto, usa _COMMON_NAME_ en lugar del nombre, y deja en comentarios el que consideres que sea correcto. Si ves que no hay nombre común en la página, usa _COMMON_NAME_  también. Si conoces el nombre común, menciónalo.
  • Usa el nombre común en lugar del científico: Es más sencillo y fácil de entender para el público general.
  • Cursiva: Se debe usar solo para marcar nombres científicos, y aquellos que estén en latín. Familia, orden y otros grupos no necesitan ir en cursiva. Si deseas marcar alguna palabra, usa negrita o “” en su lugar.
  • Trata de evitar usar meses: Las estaciones se invierten en el otro hemisferio. Trata de mencionar el momento en la estación, por ejemplo, principio de primavera, final de otoño, etc.
  • Unidades: Se deben usar pulgadas o metros, ºC o ºF y “5 – 10” como medida de rango. Si no, el sistema no detectará los números.
Errores típicos y ejemplos.

Hemos recogido los errores más frecuentes en este link: https://docs.google.com/spreadsheets/d/118JM2iTS4o4P5hoJ39k9h6tVmKIPrkI4KdB01ldjwFI/edit?usp=sharing

Por favor, trate de leer y entender estos ejemplos, ya que facilitará entender con qué estándares trabajamos, y evitará futuros errores. El link se actualizará de vez en cuando.