The Ultimate Developer Event 2013 – Learning vs. Exposure – Closing the Documentation Loop

View Github Repository Open presentation in a new window

iamca

See all presentation from iamca

The Ultimate Developer Event 2013 – Learning vs. Exposure – Closing the Documentation Loop

0 0

ude2013

On Github iamca / ude2013

The Ultimate Developer Event 2013

Learning vs. Exposure

By Corina Acosta

Closing the Documentation Loop

Ana Nelson (@ananelson)

Why is documentation an afterthought?

  • developers are expected to do it for free
  • documentation isn't valued
  • docs are futile - they become out of date quickly
  • tools suck (e.g. Wiki, Google Docs) - not designed to handle code as part of their content
  • not an inherit part of the dev's process - external interruption to our work

Food for thought:

  • give devs time to write docs
  • value documentation as if it were the product
  • keep docs up to date as you step through projects (Code/Test/Doc/Repeat)
  • make docs part of the dev process
  • use awesome developer-friendly doc tools (Dexy???)
  • refine

Why do this?

increases developer productivity and satisfaction new hires take less time to get up to speed

Automated solutions

(wikis and google docs suck)

dexy.it, asciidoc.org, docbook.org

The Frameworks of Tomorrow

Mark Otto (@mdo)
  • Github, Twitter, Creator of Bootstrap

  • Front-end frameworks are "design systems" comprised of the following:

  • Code Snippets (reusable code and content strategies)
  • Grid Systems
  • Styled Native Web Elements
  • Common components
  • JS Behavior
  • Today: Bootstrap, Foundation, Pure, Responsive Grid System
  • Future: Building design systems in-house to solve unique problems
  • Documentation as style guides (Github Style Guide)

Ditch Photoshop

Emil Anticevic (@eanticev)
  • visual design solvers: solving visual and usability problems with algorithms in code
  • eg. the wider the container that contains the text the greater the line-height.

  • You can statically set CSS but why not model this out?

    lineHeight = x * fontSize; containerWidth = pow(lineHeight, 2);

The Importance of Face-to-face Time

Adam Roben (@aroben)

"Meeting in person allows us to work better apart."

  • doesn't just apply to employees working remotely
  • social capital: the relationships between people that allow a team to function
  • socialization allows you to relate to teammates better which leads to more effective communication
  • think about it: you spend more time with the people at work than the people you love, so love the ones you're with.

The End

Start Over

Home