Learn why documentation is important, and a basic setup for small/new projects.

Instructor: Paul Roeland, Sven Strack

Length: 1/2 day

Target Level: Beginner

Target Audience: Integrator, Designer, User, Developer

  • When: Tuesday, 2:00-6:00, MIT E25-401
  • What you will learn: We'll start with a bit of theory and learn how docs are more than ‘just’ docs. Docs can help you to plan, write and debug your application and they can also boost your company or community because they let people get involved more easily. We'll also cover why is it important to test docs - both with robots and with humans - and the ‘tone’ of documentation. Then we'll examine examples of different documentation setups and software, and a good basic setup for small/new projects. We'll also take a look at docs.plone.org and how you can get involved.
  • Prerequisites: No special knowledge is needed, this class is suited for anyone who is interested in documentation. It is also useful for CEOs and managers because it covers why good docs are good for your business.
  • Things to Bring: An open mind.