Welcome Guest, Not a member yet? Register   Sign In
Authoring guide
#7

I think you'll find that the difference is primarily dependent on the author. Some authors will use real-world examples to illustrate "generic" concepts, while others are comfortable writing about the concepts at a higher level, using diagrams and pseudo-code to illustrate their points. I find that each style has its strong points, as the lack of cut & paste code examples in the latter forces me to understand the concepts better before attempting an implementation, while the former approach could get me through a tight spot in a pinch, while allowing better understanding to come along with time and further use.

Since I wasn't directly involved with most of the things you're looking for on the books I've worked on to date, I can't really help much. Leanpub takes care of a lot of the details for you on formatting/rendering the text/code (read their manual/guide before getting too far into the process, if you haven't already). The most important thing related to that is to come up with some rules to follow (and check, and double-check) to ensure that your book is consistent. For example, determine from the start what coding style guidelines you'll use in your code snippets and, if possible, configure your editor to enforce that style. You should probably also consider how formal the text will be, and which pronouns you'll use.
Reply


Messages In This Thread
Authoring guide - by ignitedcms - 10-24-2015, 04:13 PM
RE: Authoring guide - by ignitedcms - 10-28-2015, 11:24 AM
RE: Authoring guide - by Narf - 10-28-2015, 11:47 AM
RE: Authoring guide - by ignitedcms - 10-28-2015, 11:51 AM
RE: Authoring guide - by Narf - 10-28-2015, 12:02 PM
RE: Authoring guide - by ignitedcms - 10-28-2015, 12:10 PM
RE: Authoring guide - by mwhitney - 10-28-2015, 12:37 PM
RE: Authoring guide - by ignitedcms - 10-28-2015, 01:00 PM
RE: Authoring guide - by mwhitney - 10-28-2015, 02:12 PM
RE: Authoring guide - by ignitedcms - 10-28-2015, 03:11 PM
RE: Authoring guide - by kenjis - 10-29-2015, 12:21 AM



Theme © iAndrew 2016 - Forum software by © MyBB