Talk: Be a better developer with documentation
Speakers directory
Speaker:
Alexandra White
Talk description
Title:
Be a better developer with documentation
Short synopsis:
Well written instructions, informative comments throughout code, clearly scripted screencasts, and smart information architecture can take complex code and make it accessible to all developers. In the age of code sharing, this is imperative for teaching the next generation of developers, passing along your code to successors, and help you better understand your own work. Having an agile strategy for documentation will ensure you have deliverable documentation faster, requirements are known by all team members, and stakeholders will be willing to further invest in a docs effort. Developers will walk away confident that they are already capable of writing, with tools to help them write documentation well.
Max size: 500 chars
Long synopsis (optional):
Well written instructions, informative comments throughout code, clearly scripted screencasts, and smart information architecture can take complex code and make it accessible to all developers. In the age of code sharing, this is imperative for teaching the next generation of developers, passing along your code to successors, and help you better understand your own work. Documenting in parallel to development is the best way to ensure the docs are actually accurate, and that means that everyone (engineers and technical writers) must participate. When I was an engineer, docs created by my colleagues were crucial to quick onboarding to our infrastructure. Now, as a full time technical writer, I rely on our engineers to be able to concisely explain how products work. Developers will walk away confident that they are already capable of writing, with tools to help them write documentation well. They'll also understand how to create documentation for internal and external audience, optimizing the deliverables for each. Having an agile strategy for documentation will ensure you have deliverable documentation faster, requirements are known by all team members, and stakeholders will be willing to further invest in a docs effort.
Max size: 5000 chars
Tags:
Speaker directory:
Listed in directory
Not listed
Speakers directory