jsDoc-presentation

View Github Repository Open presentation in a new window

dinodsaurus

See all presentation from dinodsaurus

jsDoc-presentation

0 0

jsDoc-presentation

jsZg presentation

On Github dinodsaurus / jsDoc-presentation

@use JSDoc.

usejsdoc.org
  • Requirements
  • Architecture/Design
  • Technical
  • End user
  • Requirements
  • Architecture/Design
  • Technical
  • End user
“Why documentation?”
  • You will be using your code in 6 months
  • You want people to use your code
  • You want people to help out
  • It makes your code better

When the new guy asks where is our app’s documentation

No documentation

  • ???
  • No quick start
  • Hard development time
  • Good communication is needed
“Can we do it better?”

We are developers...

Sure!

  • Automagically generate the documentation
  • Writing documentation the fun way
  • Commenting out code

When the library has a very good documentation

BUT...

AGILE

“Working software over comprehensive documentation.”

This is how software specs should looks like. #software #documentation #spec #agile pic.twitter.com/MitwYjzy71

— Eduardo Moratto (@eduardomoratto) November 19, 2014
“We want to spend all our time coding. Remember, real programmers don't write documentation.”

The bit where I resort to reading source code in a desperate attempt to compensate for dreadful documentation

— Matthew Garrett (@mjg59) February 3, 2015

@tech_faq Software documentation is like sex: When it's good, it's really really good. And when it's bad, it's better than nothing at all.

— Jared Finklestein (@iamfinkle) December 29, 2014

Some more read

Material designgoogle.com/materialdesign

Write the docs!docs.writethedocs.org

Disadvantages of agileallaboutagile.com

Agile manifestoagilemanifesto.org

DEMO TIME

</html>

jsdoc

@dinodsaurus