Gran clase!
Introducción al Flujo Moderno de Desarrollo de Software con CodeStream
Todo lo que aprenderás sobre CodeStream
Flujo de trabajo y principio Shift Left
El editor de texto moderno
Práctica: instalación de CodeStream
El flujo moderno: productividad
El flujo moderno: productividad
GitHub en tu editor
Práctica: Integración con GitHub
Feedback Request
Práctica: flujo tradicional sin integración
Práctica: flujo tradicional integrado
Práctica: Feedback Requests
Tu herramienta de comunicación de código
Comunicación dentro del editor
Práctica: Code Chat y Code Marks, comunicación dentro del editor
Trabajo remoto y transparencia
Práctica: documentación automática del flujo
El flujo de trabajo moderno
Práctica: contribuyendo al software Open Source
El futuro del desarrollo de software
El futuro del desarrollo de software
You don't have access to this class
Keep learning! Join and start boosting your career
If you already have an account,
Resources
What are Codemarks and how do they help us?
Codemarks are an essential tool for facilitating informal and efficient conversations about code. Not only do they allow you to annotate code directly, but they also serve for the automatic creation of shareable documentation, ensuring that this documentation evolves at the pace of the code itself. The use of Codemarks in your team and organization ensures that information never becomes obsolete, thanks to their ability to adapt to any modification in the code.
How can we use and manage Codemarks?
There are several ways to manage information effectively using Codemarks:
- Relationships between Codemarks:
- Associating several Codemarks with each other.
- Add tags to identify common themes.
- Include several code blocks in a single Codemark.
We can relate multiple Codemarks to understand how different sections of code are connected. It is also possible to tag them to classify them according to certain themes, helping to streamline future searches.
How do I include more than one block of code in a Codemark?
Multiple blocks can be integrated into a single Codemark when a comment applies to different sections. To do this, after identifying and selecting the relevant code block, the user should:
- Click on "add code block".
- Select the next relevant code block in another file.
- Confirm by clicking "ok".
This is very useful when there are elements that are repeated in different contexts or files and require the same annotation.
How do we create relationships between Codemarks?
To relate Codemarks, simply access the Codestream icon and search for Codemarks that have a connection. Once identified, when clicked, the color will change to indicate that they are interconnected, showing the new status under the subheading "related".
How do we use tags in Codemarks?
Tags allow us to efficiently classify and organize our Codemarks. Tagging Codemarks with a specific standard or topic facilitates fast and accurate searches. To tag:
- Create and name the tag.
- Save it and apply it to all relevant Codemarks.
- Use search filters to access all Codemarks that share this tag.
What happens if the code changes?
One of the key advantages of Codemarks is their adaptability to code changes:
- Relocation: if a code block is moved, the Codemark automatically moves with it.
- Modifications: When the code under a Codemark is edited, an indication appears signaling the change. The user can decide whether to add a new comment or update the existing one.
How do we export information from Codemarks?
Codemarks also makes it easy to export information to other systems, expanding the possibilities for documentation and collaboration.
What is a Permalink?
Permalinks are tools that allow you to connect a piece of code to another external document. By selecting the appropriate code, you can create a link (public or private) and integrate it into other platforms, such as Google Docs, thus enriching collaborative documentation.
How do we export Codemarks?
To transform Codemarks into documents manageable in other systems, export the data in CSV format. This feature allows you to move the documentation to platforms such as Excel or Google Sheets, facilitating its manipulation and use in other contexts.
At the conclusion of this class, we will have a clearer understanding of how Codemarks not only annotate, but strengthen collaborative documentation in software development. The ability to update and export them as needed makes working as a team more efficient and productive.
Contributions 26
Questions 4
Sort by:
Prácticamente CodeStream lleva una documentación interna que puede ser exportada, algo que me pareció curioso fue la generación del enlace porque prácticamente te da una URL de ese pedazo de código documentado! Y esto también se está haciendo mediante Chat Code, ya que si no me equivoco el uso de Code Marks es prácticamente el uso del Chat Code, el cual va manteniendo la documentación 🤔
Me gusto la opción de usar Tags, de esta forma se pueden marcar los bloques de código y relacionarlos. Una función muy útil.
La documentacion hecha con codestream no queda obsoleta luego de unos cambios en el codigo. De hecho la documentacion va evolucionando con el codigo.
You have my love and respect codestream XD
Resumen de la clase
Vao! Gran clase y gran herramienta codestream. A leer la documentación 💪🏾
Los CodeMarks se utilizan para poder tener conversaciones informales y eficientes sobre el codigo, pero tambien sirven para la creacion automatica de documentacion, que se puede compartir con todo el equipo y con la organizacion en cualquier momento.
Al fin, ¡Una documentación que cambia con el código!
Prácticamente CodeStream lleva una documentación interna que puede ser exportada, algo que me pareció curioso fue la generación del enlace porque prácticamente te da una URL de ese pedazo de código documentado! Y esto también se está haciendo mediante Chat Code, ya que si no me equivoco el uso de Code Marks es prácticamente el uso del Chat Code, el cual va manteniendo la documentación 🤔
Es increíble como va transformándose conforme se realizan cambios dentro del cogido, que nos va dejando un registro de todos los cambios que hemos hecho dentro.
Clase 15 – Práctica: documentación automática de flujo
¿La documentación que creamos con los codemark se vuelve obsoleta debido a los cambios que estamos haciendo constantemente en el código?
- No.
¿Qué maneras existen para relacionar la información en CodeStream?
- Relacionar varios Codemarks.
- Agregar un tag o etiqueta en diferentes CodeMarks.
- Agregar varios bloques de código en el mismo CodeMark.
¿Hay un límite de bloques de código con los que podemos relacionar un codemark?
- No.
Muy practica esta función de documentación.
La verdad que curso tan últil. Como que todo lo que aprendimos en los pasados, aquí digievolucionan jajaja
Me encanto la forma de poder tener un URL que te permita compartir tu código de una forma más accesible!!!
Una funcionalidad muy interesante
Profesor Claudio, sería genial una integración para exportar la documentación a Notion más allá del bloque de código linkeado.
Wow eso si es poder al momento de documentar
Este curso definitivamente abre la mente. El flujo moderno es indispensable en cualquier equipo, sea cual sea el rubro.
A mi me pareció interesante, como integrar otros software a visual Studio Code, y como este editor lo integra.
Intenté probar estos features pero no me sirven 😦
Vao! Gran clase y gran herramienta codestream. A leer la documentación 💪🏾
Gran clase!
y lo mejor es que evoluciona conforme se modifica el codigo, lo que deja un registro de todos los cambios realizados. Es muy util espero aplicarlo en proyectos grandes.
¡Wao! Está bastante bueno lo efectivo que es para crear y dar seguimiento a los cambios creando documentación.
Muy buena la opción de los tags, y la opción de permalink para compartir y documentar los códigos
Esta es una herramienta brutal, para la documentación de un proyecto, se crea de manera orgánica y simple
No me aparece el mensaje de
“This code has change”
pero si me muestra el original y el current
Want to see more contributions, questions and answers from the community?