Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jcalixte/techow

Tool to create perfect technical "how"
https://github.com/jcalixte/techow

Last synced: 1 day ago
JSON representation

Tool to create perfect technical "how"

Awesome Lists containing this project

README

        

# techow

## Pourquoi ce projet ?

Ce projet a pour but d'harmoniser les comments techniques d'un projet en permettant :

- de proposer des modèles de comments techniques,
- la recherche d'anciens comments et leurs comparaisons avec les comments en cours d'écriture afin de facilité les futures estimations,
- d'avoir des retours développeurs et de récupérer la complexité réelle de tickets "ratés" ; ces retours seront ainsi automatiquement pris en compte dans la réalisation de nouveaux comments.
- standard d'architecture qui peuvent être facilement modifiable
- avoir des liens vers les standards
- Un questionnaire ?

Techow a plusieurs objectifs :

- harmoniser les comments permet d'harmoniser l'architecture du projet et d'y fixer des standards au fur et à mesure des sprints,
- rendre les journées de développeurs plus sereines en capitalisant sur les succès et erreurs des précédents tickets,
- faciliter les ateliers techniques en rendant la rédaction des comments techniques plus rapides.

TODO : tester et compter les tickets similaires