Skip to content

Latest commit

 

History

History
59 lines (59 loc) · 2.34 KB

Feedback.md

File metadata and controls

59 lines (59 loc) · 2.34 KB
Raw
  • Intro
    • Evoquer Livre Living documentation plus tot
    • "on passera très vite sur certains trucs"
      • Vous pourrez revenir dessus en consultant les slides et les sources
  • Fil rouge
    • Marteler : "Devinez quoi? C'est déjà là!"
  • Théorie
    • Déplacer Questions puis Word cloud avant les anti-patterns
    • Anti-patterns
      • Supprimer les comics et raccourcir à 2 exemples (3 max)
      • Documenter ce qui n'a pas besoin de l'être
        • Doc ephemere
        • Conversations
        • Critères pour documenter
  • Trop d'infos
    • Gray slides: Not colored background means optional for the talk.
    • Virer les comics
    • Passer les plain text en annexe
  • Pas assez de pauses
    • Lolcatz pour pause et boire un coup
  • Je me repete souvent
    • Distiller plain text au fur et a mesure au lieu du début
  • Exemples
    • For each example format the slide the same way
      • Name + illustration
      • Attributes : ⭐⭐⭐ Reliable, ⭐⭐⭐ Low-Effort, ⭐⭐⭐ Collaborative, ⭐⭐⭐ Insightful, authoritative kw source, reconciliation mechanism, internal/external, generic/specific
      • resources pointers
    • Conventions
      • Linters (generic Kw)
      • yyyy_mm_dd
    • Illustrer tous les exemples (Image, Gif , snippet ou live)
    • Convertir la section "self-doc" en exemple
    • Démo Live : living diagam "wow effect"
    • DSL
    • Ex. Javadoc
      • Changements de contexte -> IDE
    • Living diagrams
      • Demo tout intégré : cette prez + preview diagrammes
    • Code forensics
    • Doctest

      • Vos outils ont peut-être deja des fonctionalités de doc vivante!

    • Exemple de stripe
      • Api executable + generation de snippets
      • Démo et/ou Gif
      • Proche de l'exemple des notebooks
    • Emergence doc vivante : from wiki to automated script
      1. Write doc while doing (ex. deployment procedure) (Write everything!)
        • Criteria : it's critical, done several times, error prone
      2. Just wiki
      3. Wiki with some snippets
      4. GIF : it's alive!
    • crowd sourced doc - ex vueJs
      • Le mettre à la fin plutôt
      • collaboratif
      • documentation plus tradi a toujours sa place
      • single sourced (git)
      • low effort : manage merge request from community helps offload the team
  • Conclusion
    • "Vous avez les source et plein de pistes et outils"