Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

of

Writing the docs Slide 1 Writing the docs Slide 2 Writing the docs Slide 3 Writing the docs Slide 4 Writing the docs Slide 5 Writing the docs Slide 6 Writing the docs Slide 7 Writing the docs Slide 8 Writing the docs Slide 9 Writing the docs Slide 10 Writing the docs Slide 11 Writing the docs Slide 12 Writing the docs Slide 13 Writing the docs Slide 14 Writing the docs Slide 15 Writing the docs Slide 16 Writing the docs Slide 17 Writing the docs Slide 18 Writing the docs Slide 19 Writing the docs Slide 20 Writing the docs Slide 21
Upcoming SlideShare
HTTP demystified for web developers
Next
Download to read offline and view in fullscreen.

6 Likes

Share

Download to read offline

Writing the docs

Download to read offline

This presentation was held in PLOG2013, Sorrento, Italy. It's about good software development documentation culture, writing documentation for Python packages and maintaining up-to-date developer documentation in Plone ecosystem.

Related Books

Free with a 30 day trial from Scribd

See all

Related Audiobooks

Free with a 30 day trial from Scribd

See all

Writing the docs

  1. 1. Writing the docs Mikko Ohtamaa PLOG / 2013 Sorrento, Italy Friday, April 5, 13
  2. 2. Agenda The culture of good documentation Documenting Python code Documentation tools in Plone Friday, April 5, 13
  3. 3. Mikko Ohtamaa gk nr io kw o or Lo f moo9000 opensourcehacker.com Open Source 103323677227728078543 Hacker Friday, April 5, 13
  4. 4. Am I a bad person If I don’t write documentation? Friday, April 5, 13
  5. 5. YES. Friday, April 5, 13
  6. 6. Peer-driven culture vs. product-driven culture Friday, April 5, 13
  7. 7. http://blog.gerv.net/2013/03/why-the-smart-people-leav/ Friday, April 5, 13
  8. 8. Arch of Doom & i ty Outsourcing lar ess pu in companies start “German breakfast time” Po app using your product h e Tim Story begins with happy peers Friday, April 5, 13
  9. 9. “No gaps, no questions needed” documentation is necessary for the project to scale Friday, April 5, 13
  10. 10. Don’t worry ☠ Friday, April 5, 13
  11. 11. How to doc Python README.rst (PyPi, Github, .egg) Sphinx Autodoc readthedocs.org, pythonhosted.org Well-commented unit tests Friday, April 5, 13
  12. 12. developer.plone.org ( like stateful readthedocs.org with buildout ) ( like a boss ) Friday, April 5, 13
  13. 13. Consumers of Plone the project are developers Friday, April 5, 13
  14. 14. d.p.org ingredients Body of knowledge Tutorials External package documentation Graveyard of old documentation bil ity sco vera Di Friday, April 5, 13
  15. 15. [ developer.plone.org demo ] Friday, April 5, 13
  16. 16. Fix your workflow Write code Write code ~ write docs Write tests Write tests Write docs Friday, April 5, 13
  17. 17. Low-hanging fruits For every blog post you write link it For every stackoverflow.com d.p.org question you make link it For every IRC answer you receive write it ust down tio n m nfo rma uts ide I st o head exi ur yo Friday, April 5, 13
  18. 18. [ Github inline edit demo ] Friday, April 5, 13
  19. 19. Share your slides slideshare.net Link in developer.plone.org Friday, April 5, 13
  20. 20. Top-of-the-shelf bottles Theming tutorial Development friendliness out of the box Making Plone itself more dev friendly Friday, April 5, 13
  21. 21. moo9000 Open Source Hacker opensourcehacker.com 103323677227728078543 Kiitos Friday, April 5, 13
  • powerirs

    Mar. 1, 2017
  • cyriux

    Dec. 20, 2014
  • ameneghini

    Apr. 8, 2013
  • miziodel

    Apr. 8, 2013
  • TakeshiWatanabe2

    Apr. 7, 2013
  • ericof

    Apr. 5, 2013

This presentation was held in PLOG2013, Sorrento, Italy. It's about good software development documentation culture, writing documentation for Python packages and maintaining up-to-date developer documentation in Plone ecosystem.

Views

Total views

2,866

On Slideshare

0

From embeds

0

Number of embeds

1,251

Actions

Downloads

6

Shares

0

Comments

0

Likes

6

×