Writing great documentation

Presented by Jacob Kaplan-Moss on PyCon US 2011 Django’s among the best documented open source projects; I'm intensely proud of that accomplishment. If any part of Django endures, I hope it’ll be a “documentation culture” — an ethos that values great, well-written documentation. To that end, this talk looks at the tools, tips, and techniques I’ve learned over the years. I hope it helps you write great documentation, too.

Video tags:


Comments

Good stuff, thanks for sharing <3

Webinar: How to Create Awesome Documentation

Documentation is essential for every salesforce org. but where do you start? listen to this webinar!


Project Proposal Writing: How To Write A Winning Project Proposal

Project proposal writing. learn how to write a project proposal designed to get you all the project funding you need by watching this video from our expert at


Documentation Part 1: Importance and Nursing Responsibilities

the purpose of this video is to outline the importance of documentation in nursing to help you prepare for nursing exams and the jurisprudence exam. nursing re


Basic International Documentation

This video is an overview of international documentation and best practices in organizing your international trade documentation.


Good Documentation Practices (10/7/2014)

Slidetalk video created by slidetalk at


5 tips to improve your writing

want to become a better writer? in this video, i will share five easy and quick tips that will improve writing in formal and academic settings. if you're in co


Systems Documentation - Part I: Activity-Entity Table

This video demonstrates how to create an entity-activity table from a narrative describing a business process. this is a preparatory step to creating dataflow a


Documentation, Disrupted: How Two Technical Writers Changed Google Engineering Culture

Riona macnamara last year, we were inspired to action by a presentation at write the docs. this talk will tell the story of what happened next: how, in two qua


How To Write A Project Specification

In this video, dave describes a basic brainstorming approach that anyone can use to write requirement and specification documents. - connect with top offshore


Strategies for Ensuring Good Documentation Practices (GDP) Trailer

Good documentation practice (gdp) in clinical research is a baseline expectation; however, there are no set guidelines around what comprises gdp in a good clini


How to Write a Great Research Paper

An eye-opening talk... professor simon peyton jones, microsoft research, gives a guest lecture on writing. seven simple suggestions: don't wait - write, identi


15 technical writing tips

15 ways to improve your technical writing skills, develop your career as a tech writer, and improve your documentation


"Dude, Where's My RAM?" — A deep dive into how Python uses memory

presented by dave malcolm on pycon us 2011 is your python program using too much memory? this talk will give a deep dive into how cpython uses memory - start



API Documentation Overview

Not sure where to start when it comes to documentation?this video will help you understand why you need to document your api and a few effective methods for doi


Guidelines for the Preparation of Project Report for B.E/B.Tech students.

Guidelines for the preparation of project report for b.e/b.tech students. how to create project report in microsoft office word settings. for more details visit


Writing great documentation