We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

Documentation-driven development

00:00

Formal Metadata

Title
Documentation-driven development
Title of Series
Part Number
71
Number of Parts
169
Author
License
CC Attribution - NonCommercial - ShareAlike 3.0 Unported:
You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal and non-commercial purpose as long as the work is attributed to the author in the manner specified by the author or licensor and the work or content is shared also in adapted form only under the conditions of this
Identifiers
Publisher
Release Date
Language

Content Metadata

Subject Area
Genre
Abstract
Daniele Procida - Documentation-driven development One secret of Django's success is the quality of its documentation. As well as being key to the quality of the code itself, it has helped drive the development of Django as a community project, and even the professional development of programmers who adopt Django. I'll discuss how Django has achieved it, and how any project can easily win the same benefits. ----- Part of my job title is _Documentation Manager_. When I explain this to a programmer outside the Python/Django community, the reaction can be anything from bewilderment to a kind of mild horror. When I mention it to a Python/Django programmer, the response is usually: _Oh, cool_. In fact, one secret of Django's success is the quality of its documentation, and everyone who uses Django is quick to note this. The returns on Django's investment have been substantial, but some of them are also surprising. The documentation has clearly been key to the _quality of the code itself_, but also (less obviously) to the _development of Django as a community project_, and even the _professional development of programmers_ who adopt Django. I'll discuss how Django has achieved it, and how any project can easily win the same benefits.
Red HatDemonMetropolitan area networkSoftwareData structureCanadian Mathematical SocietyData managementSoftware developerCore dumpProjective planeWhiteboardEmailSystem callAddress spaceRight angleSoftware testingCodeTest-driven developmentXMLLecture/ConferenceJSONComputer animation
CodeSoftware testingLevel (video gaming)Software developerMultiplication signCodeCASE <Informatik>QuicksortMetric systemTest-driven developmentLecture/ConferenceJSONXML
CodeSoftware testingLevel (video gaming)Metric systemKeyboard shortcutComputer programmingSoftware developerProjective planeLecture/ConferenceJSONXML
Software developerState observerProjective planeMusical ensembleBitComputer animationLecture/Conference
Data structureCovering spaceStandard deviationAgreeablenessProduct (business)Process (computing)GenderData structureBitCovering spaceDivision (mathematics)Lecture/ConferenceJSONXML
CodeStandard deviationProcess (computing)Product (business)Goodness of fitAgreeablenessDifferent (Kate Ryan album)Lecture/Conference
Different (Kate Ryan album)Sound effectProgrammer (hardware)Projective planeSoftware developerOnline helpWordJSON
MereologySoftwareProgrammer (hardware)Software developerPoint (geometry)Arithmetic meanData managementXMLComputer animationLecture/Conference
Different (Kate Ryan album)Software developerXMLComputer animationLecture/Conference
Design by contractCommitment schemeTelecommunicationInformationStandard deviation3 (number)GenderStandard deviationSoftware developerSocial classDesign by contractContent (media)Commitment schemeTelecommunicationPoint (geometry)Euler anglesInformationMeeting/Interview
Programmer (hardware)Online helpComputer programmingBitComputer animation
Right angleProgrammer (hardware)Position operatorExtension (kinesiology)Group action1 (number)Confidence intervalLecture/Conference
Object (grammar)Function (mathematics)WebsiteLink (knot theory)SimulationGoogolLecture/ConferenceJSONXMLUML
Object (grammar)Function (mathematics)Content (media)Product (business)InformationOnline helpInformationContent (media)Lecture/ConferenceComputer animation
InformationContent (media)GenderWeightGoogolConnected spaceOnline helpInternetworkingLecture/Conference
Content (media)Product (business)InformationProcess (computing)InformationProcess (computing)Dependent and independent variablesComputer programmingEmailExpert systemElectronic mailing listStaff (military)Multiplication signComputer animationLecture/ConferenceMeeting/Interview
Database transactionInformationWechselseitige InformationInformationEndliche ModelltheorieDatabase transactionTelecommunicationJSON
InformationDatabase transactionWechselseitige InformationWechselseitige InformationExtension (kinesiology)InformationCommutatorDatabase transactionLecture/ConferenceJSON
Point (geometry)Goodness of fitDefault (computer science)Position operatorExpressionSet (mathematics)Expected valueStandard deviationLecture/ConferenceComputer animation
TelecommunicationExpert systemStandard deviationExpected valueMessage passingInformationComputer programmingContent (media)Lecture/Conference
InformationGenderReal numberSoftware developerGoodness of fitShape (magazine)TriangleQuicksortComputer animation
Dean numberSoftware developerSpeech synthesisEuler anglesHuman migrationDifferent (Kate Ryan album)GenderLecture/ConferenceXMLUML
Software developerCore dumpProcess (computing)MereologyBitDocument management systemProgrammer (hardware)Lecture/Conference
Moment (mathematics)ExpressionProcess (computing)Lecture/Conference
Functional (mathematics)Social classDifferent (Kate Ryan album)WritingXMLUMLLecture/Conference
QuicksortEuler anglesExpected valueComputer programmingBuildingStrategy gameXMLComputer animationLecture/Conference
Expected valueCharacteristic polynomialLecture/Conference
Programmer (hardware)QuicksortComputer programmingEuler anglesMereologyProjective planeMedical imaging
MereologyShape (magazine)Similarity (geometry)Software developerProgrammer (hardware)Lecture/ConferenceComputer animation
CodeComputer programmingMereologyState observerProgrammer (hardware)Open sourceSoftwareGoodness of fitLecture/Conference
Level (video gaming)Open sourceCodeProjective planeSource codeExpert system
MereologySoftware developerProgrammer (hardware)Projective planeData structureGenderProcess (computing)Lecture/ConferenceComputer animation
LogicSheaf (mathematics)1 (number)Functional (mathematics)CodeData structureLecture/Conference
Standard deviationStandard deviationCodeProcess (computing)Cycle (graph theory)GenderProjective planeRing (mathematics)Computer animationLecture/Conference
CodeProjective planeCore dumpComputer animation
CodeElectronic program guideGenderRight angleSoftware developerCodeProgrammer (hardware)Lecture/ConferenceComputer animation
Projective planeSoftwareOpen sourceSocial classComputer animation
Projective planeOpen sourceSoftwareSoftware developerLecture/ConferenceComputer animation
Projective planeSoftware developerEuler anglesRight angleMultiplication signDirection (geometry)Lecture/Conference
CAN busData structureCodeInformationWeb pageCategory of beingProjective planeMixed realityPoint (geometry)Position operatorTask (computing)Data structureJSON
CAN busData structureCodeInformationLecture/ConferenceJSON
Level (video gaming)CodeBitElectronic mailing listStapeldateiCartesian coordinate systemLecture/Conference
Data structureCodeInformationCAN busMereologyDocument management systemSheaf (mathematics)Finite-state machineSet (mathematics)InformationMultiplication signProjective planeCommitment schemeMereologyCore dumpSoftware developerJSON
Multiplication signDependent and independent variablesWeb pageRight angleOpen sourceLecture/ConferenceJSONXMLUML
Computer programmingMultiplication signWebsiteLecture/Conference
FamilyMereologyRight angleSoftware developerJSONXMLUMLLecture/Conference
Product (business)InformationEuler anglesInformationComputer animation
Multiplication signCoefficient of determinationSynchronizationMereologyRight angleCodeComputer animation
Software testingCodeBitSoftware developerMultiplication signMereologyMathematicsState of matterWeightMeeting/Interview
Projective planeSynchronizationSoftware testingRule of inferenceIntegrated development environmentGenderPatch (Unix)Code
CAN busData structureCodeInformationSoftware testingComputer programmingRight angleString (computer science)Programmer (hardware)Descriptive statisticsWritingVirtual machineMaterialization (paranormal)Lecture/ConferenceJSON
Online helpDisk read-and-write headFunctional (mathematics)Descriptive statisticsMeeting/Interview
Level (video gaming)Software developerDecision theoryCASE <Informatik>Code
MereologyWeightFormal languageOrder (biology)Data structureWritingDirection (geometry)Process (computing)
BitSoftware developerComputer programmingStatement (computer science)Multiplication signSelf-organization
MereologyEuler anglesMathematicsLecture/ConferenceMeeting/Interview
Formal languageMoment (mathematics)Sound effectComputer configurationTranslation (relic)Open sourceProcess (computing)Wage labourGroup actionLecture/ConferenceMeeting/Interview
Social classSound effectMultiplication signFeedback
DemonSoftware developerLecture/ConferenceXML
Transcript: English(auto-generated)