• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
Writing the docs
 

Writing the docs

on

  • 1,879 views

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 ...

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.

Statistics

Views

Total Views
1,879
Views on SlideShare
1,002
Embed Views
877

Actions

Likes
4
Downloads
1
Comments
0

13 Embeds 877

http://opensourcehacker.com 403
http://architects.dzone.com 183
http://www.abstract.it 110
http://feeds.feedburner.com 66
http://java.dzone.com 65
http://gestione-www.abstract.it 24
http://newsblur.com 8
http://www.feedspot.com 7
http://www.newsblur.com 6
http://old-www.abstract.it 2
http://www.dzone.com 1
http://hivereader.com 1
http://cloud.feedly.com 1
More...

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

CC Attribution License

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

    Writing the docs Writing the docs Presentation Transcript

    • Writing the docs Mikko Ohtamaa PLOG / 2013 Sorrento, ItalyFriday, April 5, 13
    • Agenda The culture of good documentation Documenting Python code Documentation tools in PloneFriday, April 5, 13
    • Mikko Ohtamaa gk nr io kw o or Lo f moo9000 opensourcehacker.com Open Source 103323677227728078543 HackerFriday, April 5, 13
    • Am I a bad person If I don’t write documentation?Friday, April 5, 13
    • YES.Friday, April 5, 13
    • Peer-driven culture vs. product-driven cultureFriday, April 5, 13
    • http://blog.gerv.net/2013/03/why-the-smart-people-leav/Friday, April 5, 13
    • 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 peersFriday, April 5, 13
    • “No gaps, no questions needed” documentation is necessary for the project to scaleFriday, April 5, 13
    • Don’t worry ☠Friday, April 5, 13
    • How to doc Python README.rst (PyPi, Github, .egg) Sphinx Autodoc readthedocs.org, pythonhosted.org Well-commented unit testsFriday, April 5, 13
    • developer.plone.org ( like stateful readthedocs.org with buildout ) ( like a boss )Friday, April 5, 13
    • Consumers of Plone the project are developersFriday, April 5, 13
    • d.p.org ingredients Body of knowledge Tutorials External package documentation Graveyard of old documentation bil ity sco vera DiFriday, April 5, 13
    • [ developer.plone.org demo ]Friday, April 5, 13
    • Fix your workflow Write code Write code ~ write docs Write tests Write tests Write docsFriday, April 5, 13
    • 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 yoFriday, April 5, 13
    • [ Github inline edit demo ]Friday, April 5, 13
    • Share your slides slideshare.net Link in developer.plone.orgFriday, April 5, 13
    • Top-of-the-shelf bottles Theming tutorial Development friendliness out of the box Making Plone itself more dev friendlyFriday, April 5, 13
    • moo9000 Open Source Hacker opensourcehacker.com 103323677227728078543 KiitosFriday, April 5, 13