Colay / Guías

Reescribe un artículo de la base de conocimientos sin perder sus instrucciones

Una reescritura de la base de conocimientos debería aclarar la siguiente acción del lector. En Colay, varios borradores de IA pueden revelar si un artículo funciona mejor como un procedimiento breve, un árbol de resolución de problemas o una explicación con ejemplos. Comience con un artículo y una hoja informativa verificada. Su entregable es un artículo revisado con instrucciones rastreables, no una colección de paráfrasis atractivas.

Dé al artículo un lector y un trabajo

Un artículo sobre cómo cambiar la configuración de notificaciones puede combinar actualmente la configuración de la cuenta, los permisos y la solución de problemas. Antes de reescribir, indique el punto de partida del lector y el resultado que debe lograr. Coloque todo lo demás en requisitos previos, enlaces relacionados o en un artículo aparte. Esta elección editorial a menudo importa más que cambiar el tono.

Cree una tarjeta de tarea: identificador del artículo, audiencia, versión del producto compatible, rol requerido, etiquetas de interfaz exactas, resultado esperado, excepciones conocidas y propietario. Utilice únicamente material aprobado. Si un paso es incierto, etiquételo para su verificación en lugar de pedirle a un modelo que llene el vacío de la memoria. La guía de procedimientos de Google admite pasos centrados en la acción y suficiente contexto para localizar la acción.

Una reescritura ficticia con datos fijos del producto

Considere una herramienta de espacio de trabajo ficticio. Los miembros pueden silenciar las notificaciones personales por correo electrónico en Configuración → Notificaciones. Solo un propietario puede cambiar los valores predeterminados de toda la organización. La configuración guardada afecta los correos electrónicos futuros; no elimina los mensajes que ya están en cola. Estas son entradas inventadas para el ejemplo, no características de Colay.

Pregunte por estructuras distintas utilizando los mismos hechos. Un procedimiento ayuda a alguien a completar la tarea inmediatamente; una versión de solución de problemas ayuda a alguien que no puede encontrar el control. Las preguntas frecuentes pueden explicar la excepción del correo electrónico en cola. Son posibles ocho enfoques solicitados, pero deberían abordar ocho situaciones de lectura en lugar de multiplicar las mismas oraciones.

Elija la estructura según el obstáculo del lector
Situación del lectorFormato útilHecho que debe sobrevivir
Sé lo que quiero cambiarProcedimiento numeradoConfiguración → Notificaciones es la ubicación proporcionada
No puedo cambiar el valor predeterminado de la organizaciónSolución de problemas basada en rolesSolo un propietario tiene el permiso indicado
Silencio el correo electrónico pero recibí otro mensajeBreve explicación con excepciónLos mensajes en cola no se ven afectados

Un mensaje que separa la redacción de la verdad del producto

Utilice Ask separately en Colay para ver cómo los agentes seleccionados interpretan la tarea. Compare sus esquemas antes de perfeccionar artículos completos. Si una respuesta elimina el requisito de permiso mientras que otras lo conservan, inspeccione la fuente aprobada. El acuerdo no sustituye la prueba del flujo de trabajo documentado.

Vuelva a escribir este artículo aprobado de la base de conocimientos: [texto]. Tarjeta de tareas: [audiencia, versión del producto, rol, etiquetas exactas de la interfaz de usuario, resultado esperado, excepciones]. Produzca un tutorial numerado, una versión de solución de problemas y una versión corta de preguntas frecuentes. Preservar todas las condiciones, permisos y excepciones. No invente controles ni comportamientos. Para cada versión, indique la oración fuente que respalda cada instrucción. Coloque el material fuente poco claro o contradictorio en una lista de preguntas separada. Recomiende una estructura para [situación del lector] y explique la elección. No combine silenciosamente datos de diferentes versiones de productos.

Convierta el mejor borrador en una revisión publicable

El artefacto final puede ser pequeño: título aprobado, requisitos previos, procedimiento, resultado esperado, excepciones y un siguiente enlace relevante. Mantenga el mapeo de la fuente a la instrucción con las notas editoriales. Colay ayuda a redactar y comparar; este flujo de trabajo no implica que pueda conectarse a su base de conocimientos o publicar cambios automáticamente.

  1. Elija la estructura que coincida con la tarjeta de tarea. Conserve las frases útiles de otros borradores sólo después de comprobar su significado.
  2. Recorra cada paso de la versión compatible del producto con el rol indicado. Verifique las etiquetas, el orden, el resultado y la excepción documentada.
  3. Lea el artículo como nuevo usuario: los requisitos previos deben aparecer antes de que sean necesarios y un paso fallido debe tener una siguiente acción disponible.
  4. Registre el revisor, la versión del artículo y las secciones modificadas. Publique a través del flujo de trabajo de su base de conocimientos existente y conserve la versión anterior para comparar.

Juzga la reescritura por lo que puede hacer el lector

Pídale a un colega que no esté familiarizado con el borrador que encuentre el punto de partida, identifique su requisito de permiso y explique qué sucede después del último paso. Registre los malentendidos como problemas de edición. Si tiene comentarios o datos de búsqueda para ese artículo, compare las mismas señales después de la publicación sin atribuir todos los cambios a la IA. Deje de generar cuando el trabajo restante sea un dato faltante del producto, no una elección de redacción.

Preguntas y respuestas

¿Deberían publicarse las ocho versiones?

Normalmente no. Son candidatos para una tarea de lector. Publicar la versión apropiada más clara; Separe los artículos sólo cuando respondan a necesidades realmente diferentes.

¿Puede el modelo reparar instrucciones obsoletas?

Solo cuando proporciona datos de reemplazo verificados. Un nuevo nombre de botón plausible no es evidencia de que el producto se comporte de esa manera.

¿Qué pasa si el artículo contiene ejemplos de clientes privados?

Utilice sólo ejemplos que pueda compartir. Elimine los identificadores innecesarios y sustitúyalos por un ejemplo ficticio donde la identidad no agregue ningún valor instructivo.

Fuentes y metodología

  1. Google: writing procedures

    Orientación principal sobre contexto y pasos de acción claros; el flujo de trabajo ficticio y el método de revisión son los ejemplos de este artículo.

Envíe su próxima pregunta a Colay

Elija un modelo, utilice Auto o reúna varias perspectivas con Consensus.

Reescribir mi artículo