[Eric] Eric (4) Python IDE Documentation—Who cares?
GadgetSteve at live.co.uk
Thu Jul 7 08:17:46 BST 2011
On 06/07/2011 11:43 AM, Pietro Moras wrote:
> If you care having Eric (4) Python IDE documented, here is the URL:
> where to find a first “open” draft, open to your questions and
> That is, if you are an active user, eager to see such documentation
> improved and updated, you are encouraged to express your thoughts,
> posted here, or on the LinkedIn “Active User Conference” Group; or
> privately, too.-
> You are welcome.
> The Author
> Eric mailing list
> Eric at riverbankcomputing.com
> > Hi Pietro,
> > I have only had time for a quick skim and generally my impressions
> are favourable but I would like to make a couple of suggestions,
> hopefully constructive ones:
> > 1. Change your pdf settings to not show crop/registration marks,
> (I personally find them a distraction and I am sure that many others
> will as well.
> > 2. Why no table of contents? Please have one, preferably with
> click-able links it makes finding things much easier.
> > 3. It would be nice to include an Acknowledgements section
> > 4. Second copyright page, (according to the header), does not
> contain any copyright, or left, information - it does contain the
> Foreward, this should be on its own, correctly headed page.
> > 5. Run - page 4 - Eric.bat presumes a windows environment as Eric
> is multi-platform this will not always be true.
> > 6. As chapter 2 - Menus is over 90 pages it should be divided
> into sub-chapters, (possibly one for each top level menu would be a
> good starting point, the header should also include at least the same
> level of title division.
> > 7. It would be nice to include examples of setting up the following:
> > 1. A brand new project,
> > 2. A new project for existing source code,
> > 3. A multi-project,
> > 4. A project debug session.
> > 8. Generally add on installation to cover things like pylint
> would be useful.
> > 9. Please consider supplying your final version, and possibly
> later drafts, in a format that is compatible with Eric's help system,
> preferably with either install instructions, or better an install
> script, to attach it to the help menu.
> > 10. I would consider the document less a technical report than an
> independent user guide and also think that it would get a, well
> deserved, wider readership if re-titled and described as such.
> > Personally I feel that many, especially new, users will find it very
> helpful, (hence suggestion 9 above).
> > Well done!
> > Gadget/Steve
On 06/07/2011 7:35 PM, Pietro Moras wrote:
> Hi Gadget/Steve,
> Not bad for a “quick skim”, I've appreciated it.
> As for working on your suggestions, please consider these are my
> 1] To get in touch with Eric “Active Users” so to work in team, to the
common benefit. By the way:
> 1.1] I'm already in excellent relations with the Eric's producer. Now
I'd like to extend this collaboration to some users too.
> 1.2] Is there any reason why you have expressed your thoughts
privately, instead of on the Mail List? Reason for may question is
respect for your preferences, in case our dialogue would get on.
Simply hit the wrong button - should have been reply to list.
> 2] To Test & Document other unexplored Eric's features, provided I
find experienced users to work with on them. My first candidate would be
the “Source Code Management”, or “Version Control System”; but I'd
welcome other proposals too.
> 3] To find out a good channel of distribution for the resulting work,
to the benefit of the Eric's user community.
> 4] To take better care of the “editing” quality of the outcome. That
is: good English, effectiveness, readability, ...
> To lure you on this adventure consider that there's involved no money,
hard work and little glory.
> See you.
> - P.M.
One immediate tip for you is that possibly most users of this list, like
many others, prefer bottom posting, i.e. posting at the end - this
allows people to join in in context rather than having to jump about the
text. The simple reason for the direct reply is hitting the wrong
button - still getting used to Thunderbird.
While I agree that more content is better I have found that getting a
good structure early on saves a lot of work and also makes it possible
for reviewers to focus on areas that they are familiar with.
If you are not looking for lots of money as an outcome possible
distribution channels would include bundling it in with Eric, Simply
publishing it to the web, etc., if you would hope for some remuneration
then take a look at the publishers of other python books, (PythonBooks
<http://wiki.python.org/moin/PythonBooks>is a good place to start).
As to the adventure I would be willing to try to assist but have to warn
you that my time is heavily committed.
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the Eric