This repository has been archived by the owner on Aug 12, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Getting started
Jose Carlos Urra Llanusa edited this page Mar 25, 2020
·
10 revisions
- Join the discord chat, there are channels for different repositories
See this documentation example. You can also download it to see the final result.
-
Download or clone this template to start documenting easily
-
Fill in the source files like STLS, CAD, etc inside
-
Use this one template to create new designs documentation
- Inside docs write down a simple README in language of choice.
- Put in the README.md the reference whre you got the source from to follow up.
- Write down steps to replicate if necessesary as well as guides in sequence.
If this part becomes difficult ask for help here in the
#how-to-document-designs
channel
Vea este ejemplo de documentación. Puede tambien descargar este ejemplo.
-
Descargue o clone esta plantilla para comenzar a documentar fácilmente
-
Complete los archivos de origen como STLS, CAD, etc. dentro
-
Utilice esta plantilla para crear documentación de nuevos diseños.
- Los documentos internos escriben un archivo README simple en el idioma de su elección.
- Ponga en README.md la referencia de donde obtuvo la fuente para hacer el seguimiento.
- Escriba los pasos para replicar si es necesario, así como las guías en secuencia.
Si esta parte se vuelve difícil, solicite ayuda aquí en el canal [
# how-to-document-designs
] (https://discord.gg/QrAyWF)