So, after over a year of learning, development, implementation and testing, I am very near the point where my Raspberry Pi Perl software is ready for prime-time use by the masses. After a few more tweaks, test additions, documentation updates and one last once-over, I plan on writing a "Howto Pi with Perl" type tutorial, across several articles in a series.

Trying to put together some sort of sane format, I'm looking to those who have publishing experience or technical writers to give my initial thoughts a once-over and provide me any feedback. Most, if not all portions will include breadboard diagrams of each task, code (of course), pictures if reasonable and in some cases potentially even video clips.

Initial, broad-view structure:

update: I think I'm going to use this as my initial template, so I may periodically update it with feedback and new ideas.../update

For each element that contains a specific topic, include, where feasible/available a section at the bottom of the doc for advanced users perhaps in <small> or equivalent tags (these are just thoughts, nothing firm):

Any thoughts on this general first thoughts layout? Anything that I should include that's not already? Anything I should remove? How about any thoughts on the individual elements and the manner in which to present them?

I think I will create the actual demonstration parts first, then weave in the commentary thereafter. At first thought, this seems like the simplest approach that'll allow me to review all of the actual working parts as I go back through and edit in commentary.

Thanks,

-stevieb

In reply to Contemplating a documentation series for my Raspberry Pi work by stevieb

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.