Shop OBEX P1 Docs P2 Docs Learn Events
Are you verbose enough? — Parallax Forums

Are you verbose enough?

rjo__rjo__ Posts: 2,114
edited 2014-08-09 08:32 in Propeller 1
We are going to have experts in FPGA design, who know nothing about the Prop1... and Prop1 gurus who know nothing about FPGA's... and we are going to have people that don't know anything about FPGA's or the Prop1
... and we are going to have everyone in between. We want all of them to be happy:)

I certainly have no problem with experts talking to experts using short hand descriptions. I actually enjoy it,

...but if you want your submissions to be most readable by the widest audiences, please remember to be as verbose as your time permits.

For example, if you mention a circuit, describe it completely or include a drawing or better yet, a picture. I love pictures... admit it... you do too:)

If you are modifying code or settings... please describe exactly what you did to modify it(at least once in your thread).

Repetition is a good.

Thanks,

Rich

Comments

  • prof_brainoprof_braino Posts: 4,313
    edited 2014-08-09 08:32
    Hear, hear!

    Spelling out acronyms and three letter abbreviatins (TLA's) the first time used (in each thread or document) is a good habit.

    Indicating which code applies to the physical hardware and which applies to the simulated hardware can be helpful.

    When discussing experiments, indicate what is being tested (the goal), and what is known (the basis for the hyposthesis being tested).

    Little stuff can make a big difference in communication.

    Perhaps "Strive for the minimum necessary and sufficient to completely convey the thought" is a suitable way to express this as a "best practice".
Sign In or Register to comment.