Skip to content
This repository has been archived by the owner on Mar 5, 2024. It is now read-only.

Commit

Permalink
add existing EST-BDT from wiki to GitHub Page
Browse files Browse the repository at this point in the history
  • Loading branch information
Frida Bailleres committed Feb 29, 2024
1 parent 958ce5f commit 098e4fa
Show file tree
Hide file tree
Showing 4 changed files with 96 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/estandares/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Estándares",
"position": 3,
"link": {
"type": "generated-index"
}
}
54 changes: 54 additions & 0 deletions docs/estandares/est-bdt-001.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# EST-BDT-001 Redacción para Documentos

v 1.0.1

## Propósito

El propósito de este documento es establecer los estándares que se deberán seguir para redactar cualquier documento departamental.

## Notas introductorias

La importancia de este documento es mantener un estándar e identidad para todos los documentos del departamento y definir de qué manera serán redactados y estilizados.

## Estándares

### Estilos

1. La tipografía para títulos es Nunito número 14 en negritas.
2. La tipografía para subtítulos es Nunito número 12 en negritas.
3. La tipografía para el cuerpo del documento es Open Sans número 10.
4. El interlineado es de 1.15.

### Redacción

1. Los verbos se escriben en infinitivo (terminaciones ar, er, ir).
2. Se referirá a la Organización Socio Formadora como Cliente.
3. El nombre de una fase debe ser conciso y comenzar con alguna de las siguientes sugerencias:
1. **Inicio / Análisis**: Esta fase está fuertemente ligada al entendimiento de las entradas del proceso y representa el punto de partida para dar paso a su ejecución.
2. **Definición**: En esta fase el propósito del proceso se ve reflejado en sus actividades porque se enfocan en la transformación de sus entradas a sus salidas.
3. **Verificación**: Con las actividades de esta fase se busca retroalimentar el contenido del proceso hasta el momento y se especifica a qué fase deben regresar en caso de necesitar cambios.
4. **Seguimiento**: Una fase perteneciente a esta categoría engloba actividades relacionadas al monitoreo y seguimiento de las salidas del proceso.
5. **Notificación**
6. **Ejecución**: Actividades que necesitan de una acción inmediata para ser completadas.
7. **Documentación**: En esta fase se consideran las actividades relacionadas al registro de información de las salidas del proceso en un documento oficial para que todo el departamento tenga acceso.
8. **Solicitud**

### Versiones

1. Las versiones se escriben conforme al estándar _[Semantic Versioning 2.0.0](https://semver.org/)_.
2. Las versiones se escribirán con una _v_ antes del número de la versión.

### Diagramas

1. Los diagramas de proceso son opcionales, a menos que se indique lo contrario, y deben estar en escala de grises y lenguaje UML bajo los [estándares de diagramas UML](https://github.com/Black-Dot-2024/docs/wiki/EST%E2%80%90BDT%E2%80%90002-Diagramas-UML).

### Fechas

1. El formato de las fechas es dd/mm/aaaa.

## Control de cambios

| Versión | Cambio | Autor del cambio | Aprobado por | Fecha de cambio |
| ------- | -------------------------------------------- | --------------------------------------------------------------- | ------------ | --------------- |
| v 1.0.0 | Creación del documento | Sergio Garnica González | | 26/02/2024 |
| v 1.0.1 | Estándares para el nombramiento de las fases | Sergio Garnica González <br/> Ramona Najera <br/> Armando Rosas | | 26/02/2024 |
34 changes: 34 additions & 0 deletions docs/estandares/est-bdt-002.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# EST-BDT-002 Diagramas UML

## Propósito

El propósito de este documento es establecer los estándares que se deberán seguir para diseñar cualquier tipo de diagrama UML.

## Notas introductorias

La importancia de este documento es mantener un estándar e identidad para todos los diagramas UML que se han de realizar por el departamento, definiendo los colores, figuras y herramientas para desarrollarlos.

## Estándares

### Estilos

1. Los colores a utilizar serán escala de grises.

### Redacción

1. Los verbos se escriben en infinitivo (terminaciones ar, er, ir).
2. Los actores se escribirán en singular.

### Herramientas

1. Las herramienta a utilizar para diseñar los diagramas será [draw.io](https://app.diagrams.net/).

### Figuras

1. Usar las figuras presentadas en [este diagrama](https://lucid.app/lucidchart/661beab2-311a-4255-b153-dd8a5799374b/edit?invitationId=inv_4e4282af-3e5d-49a2-9e7a-bc3ded660366&page=wBzdocGomGPM#).

## Control de cambios

| Versión | Cambio | Autor del cambio | Aprobado por | Fecha de cambio |
| ------- | ---------------------- | ---------------- | ------------ | --------------- |
| v 1.0.0 | Creación del documento | Sergio Garnica | | 26/02/2024 |
2 changes: 1 addition & 1 deletion docs/politicas/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Políticas",
"position": 3,
"position": 2,
"link": {
"type": "generated-index"
}
Expand Down

0 comments on commit 098e4fa

Please sign in to comment.