‘Documentation’ Videos

  • Documento, quindi esisto

    WordCamp Turin (Torino) 2023Speaker: Enrico Sorcinelli

    April 27, 2023 — Non importa quanto sia meraviglioso il codice e quanto sia intelligente il suo design, se si è gli unici a capirlo.
    Spesso la documentazione è la parte più sottovalutata del processo di sviluppo di un software.
    In questo speech capiremo perché è importante documentare illustrando alcune linee guida su come farlo al meglio.

    Presentation Slides »

  • Docs or it didn’t happen

    WordCamp Italy (Italia) 2022Speaker: Milana Cap

    December 18, 2022 — Your code can be all rainbows and unicorns, cutting and shining, but if there’s no documentation, does it even exist?

    Documentation can make or break your open source project. Don’t believe me? Let me tell you a story or three about writing and managing documentation for the largest open source CMS community. The WordPress documentation.

    Presentation Slides »

  • Ryan King: Oops!.. I Did It Again.

    WordCamp Lancaster 2018Speaker: Ryan King

    February 7, 2021 — Join me on my journey from random note-taking and scattered doodles to an organized system of documentation. I have been on a personal quest to establish a healthy, productive habit of ritual documentation and journaling. Both for workplace projects and personal growth, I have been experimenting with and assessing different practices of recordkeeping and review with the end goal of reflection, archiving, and establishing workflows and protocols.

    Drawing from concepts of software development, time management, and agile flows, I will lead you through what I have discovered and will share various tools and systems that have been beneficial along the way. Part demo, part open forum, this session will help you achieve your path to documentation Nirvana.

  • Alice Orrù: Scrivere una documentazione tecnica efficace: lo stai facendo bene?

    WordCamp Italia 2020Speaker: Alice Orru

    November 2, 2020 — Se sviluppi temi e plugin, la documentazione tecnica dovrebbe essere un tassello fondamentale per supportare le persone che usano il tuo prodotto.
    Eppure spesso la stesura dei documenti tecnici viene bistrattata o relegata a oscure pagine scritte in “tecnichese”.
    In questo talk vedremo alcune buone pratiche per scrivere una documentazione tecnica efficace, anche quando l’argomento da trattare è ostico.
    Vedremo come produrre testi chiari, che sappiano parlare al tuo pubblico di riferimento senza fargli venire il mal di testa e, soprattutto, che offrano tutte le risposte necessarie per usare al meglio il tuo tema o plugin.

    Presentation Slides »

  • Tomáš Kocifaj: ‘Vyhlašte s námi boj špatným projektům

    WordCamp Prague 2020Speaker: Tomáš Kocifaj

    July 16, 2020 — ‘Budu mluvit o “Boji proti špatným projektům”. Jsem spoluzakladatel firmy Brilo Team s.r.o., kde se už dlouhá léta zabýváme vývojem projektů právě na systému WordPress. Za tu dobu jsme se setkali už se spoustou klientů, kteří často (i svou chybou) nechali vytvářet projekt, který ve finále neodpovídal tomu, co potřebují. Chceme proto ukazovat a vysvětlovat lidem, jak by měli na tvorbu webového projektu pohlížet. Stejně tak jim dodat potřebné materiály, jako je vzor zadávací dokumentace, vzor technické specifikace, vzor smlouvy o dílo, atd.

  • Dario Jazbec Hrvatin: World Wide Documentation

    WordCamp Prague 2020Speaker: Dario Jazbec Hrvatin

    July 7, 2020 — Learn about writing and managing documentation in the WordPress world. Dario Jazbec Hrvatin shares tools, tips, and thinking from his five years of experience as a professional documentation manager.

  • Maura Teal: The Self-Documenting Developer

    WordCamp Phoenix 2020Speaker: Maura Teal

    June 18, 2020 — During this talk I will break down the actions we take to handle the firehose of information that flows through Slack and other mediums, and the lessons we learned along the way.

    Presentation Slides »

  • Ajit Bohra: StoryBook – Building, Testing & Documenting Components

    WordCamp Udaipur 2019Speaker: Ajit Bohra

    December 25, 2019 — With Gutenberg, we are talking more about React and it’s component-based development. Breaking down the app into component helps in better organization and reuse. But growing components can quickly become overwhelming and error-prone. Storybook comes to the rescue to help you build components in isolation and test for various use cases. Also, it serves as centralized documentation for the team. The talk will help you understand what is a Storybook and how it can help you and what are its various features. A quick dive into setting up and writing stories.

    Presentation Slides »

  • Kate Bolin: Documentation – Because Everyone Dies!

    WordCamp Belfast 2018Speaker: Kate Bolin

    April 23, 2019 — Sure you think you’re going to be around forever, but one day, somehow, you will not be working on that website.

    How do you make life easier for your clients, your colleagues, your replacements, and yourself?

    Discover the power of documentation!

  • Katherine White: Documentation for Developers

    WordCamp US 2017Speaker: Katherine White

    December 8, 2017 — Developers who love to write docs are pretty rare. But documentation is a critically necessary evil throughout a site’s life, from initial development through to ongoing support and enhancements. How much documentation is too much? Not enough? As developers, how can we produce meaningful documentation that supports our code and sets it up for success once it launches out into the world… without making ourselves completely crazy in the process?

    We’ll explore a structure for documenting your codebase, the components of strong documentation, and how these project artifacts evolve over time.