Guía de estilo: política
TopicFrom the PointSav Documentation
Estándares editoriales para documentos de política (género LEGAL): disciplina de alcance, formato de reglas numeradas, cláusula de aplicación, cadencia de revisión y distinción entre política y ADR.
Una política establece qué se requiere, quién está obligado y qué ocurre cuando se viola la regla. Cada oración de una política es una regla o el soporte de una regla. Se diferencia de un ADR (que registra una decisión arquitectónica puntual) — véase Decisiones de Arquitectura.
[edit]Cuándo usar esta plantilla
Se usa una política cuando el comportamiento debe ser uniforme en un equipo, proyecto u organización, cuando la desviación tiene consecuencias reales que deben establecerse, y cuando la regla necesita una cadencia de revisión para no quedar obsoleta en silencio. No se escribe una política para una preferencia o guía; una guía lleva "preferido" o "recomendado" y no implica aplicación.
[edit]Estructura requerida
Cinco secciones en orden:
- Scope — a quién y qué aplica esta política. Roles, sistemas o contextos nombrados. Explícito sobre lo que no aplica.
- Policy — las reglas, numeradas. Cada regla es una declaración completa y autónoma. La primera palabra es una obligación: "Todo X debe…", "Ningún Y puede…", "Todo Z está obligado a…".
- Enforcement — qué ocurre cuando se viola una regla. Debe nombrar una consecuencia o un proceso, no un vago "será abordado."
- Review — con qué frecuencia y por quién se revisa esta política. Mínimo anual.
- See also — vínculos a los ADR, convenciones o leyes que esta política implementa o requiere.
[edit]Registro
Legal-llano. Voz activa. Sin conjeturas: "debe" y "no puede" para requisitos. "Debería" y "se recomienda" no son lenguaje de política. Máximo veinticinco palabras por regla.