Grokking the paradigm why i get confused and what i m doing about it
This presentation is the property of its rightful owner.
Sponsored Links
1 / 14

Grokking the Paradigm: Why I Get Confused (and what I’m doing about it) PowerPoint PPT Presentation


  • 59 Views
  • Uploaded on
  • Presentation posted in: General

Grokking the Paradigm: Why I Get Confused (and what I’m doing about it). Dennis Dawson Principal Technical Writer EMC/Documentum. Here’s what I’m gonna talk about: Warm up quotations Why I get confused (and why I’m not surprised) How I’m addressing my concerns. Ten Minutes’ Worth of Stuff.

Download Presentation

Grokking the Paradigm: Why I Get Confused (and what I’m doing about it)

An Image/Link below is provided (as is) to download presentation

Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author.While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server.


- - - - - - - - - - - - - - - - - - - - - - - - - - E N D - - - - - - - - - - - - - - - - - - - - - - - - - -

Presentation Transcript


Grokking the paradigm why i get confused and what i m doing about it

Grokking the Paradigm:Why I Get Confused(and what I’m doing about it)

Dennis Dawson

Principal Technical Writer

EMC/Documentum


Ten minutes worth of stuff

Here’s what I’m gonna talk about:

Warm up quotations

Why I get confused (and why I’m not surprised)

How I’m addressing my concerns

Ten Minutes’ Worth of Stuff

Grokking the Paradigm


What the

What the...?

Multiplicitas componatisres simplex*

Bacchus Filius Aurorae

*Complexity is composed of simple things.

Grokking the Paradigm


What the1

What the...?

If you can’t explain

something simply, you

don’t understand

it well enough.

Albert Einstein

Grokking the Paradigm


What the2

What the...?

Magic is easy, once YOUknow the secret!

Marshall Brodien

Grokking the Paradigm


Grokking the paradigm why i get confused and what i m doing about it

BTFM

  • You may be familiar with the acronym

    RTFM

    (read the fabulous manual)

  • If you’ve read our documentation and you still don’t know what to do next, I suggest you

    BTFM

    (blame the fabulous manual)

Grokking the Paradigm


Why am i confused nothing does anything

Why Am I Confused?Nothing Does Anything

  • Taken out of context, nothing does anything

    • Abstraction

    • Re-use

    • Automagic Triggers

  • Nothing does anything by itself

    • Components are interrelated and multilayered

    • Behavior is isolated from the interface

    • Commands are often redirected

Grokking the Paradigm


Why am i confused backward compatibility

Why Am I Confused?Backward Compatibility

  • Backward compatibility is a double-edged sword

    • Standards change quickly

    • Customizations migrate slowly

  • Some things that were originally donefor a very good reason are no longernecessary, but can’t be revised.

Grokking the Paradigm


Why am i confused words have meaning

Why Am I Confused?Words Have Meaning

“You keep using that word – I do not think it means what you think it means.”

-Inigo Montoya, The Princess Bride

  • The terms in use made sense at the time they were created

  • Names can be redundant, misleading

  • Some represent two colliding ideas:

    firePreSubmitClientEvent (postServerEvent.GENERIC_PRE_SUBMIT)

Grokking the Paradigm


Why am i confused some words have no meaning

Why Am I Confused?Some Words Have No Meaning

  • Frequent use of self-referential variables

  • Arguments passed in a string array called “args”

    • Often the pertinent information you want is one of the “args”

    • No way of knowing what the values are/should be without tracing through the logic

    • No way of knowing whether the arguments are significant until you trace through the programming logic

      postServerEvent( null, null, null,

      "onClickObject", "objectId", id,

      "type", type, "isFolder", isFolder);

      }

Grokking the Paradigm


Ways i m addressing these issues minimalism

Ways I’m Addressing These IssuesMinimalism

  • Few people read documentation

  • Minimalist documentation provides just enough information to allow a user to solve a problem and continue working

  • Done properly, users learn faster and show better retention

Grokking the Paradigm


Ways we re addressing these issues embedded documentation

Ways We’re Addressing These IssuesEmbedded Documentation

For D6, documentation is now embedded in

  • Configuration files

  • TLD files

  • Improved Javadocs

Grokking the Paradigm


Ways i m addressing these issues usage examples

Ways I’m Addressing These IssuesUsage Examples

  • Short examples

  • Practical examples

  • Alternative examples

  • One concept per example

Grokking the Paradigm


Grokking the paradigm why i get confused and what i m doing about it

Clarifications/comments?Please send them to:[email protected] Questions? Please visit:http://developer.emc.com/developer/


  • Login