Chapter writing methodology

From The_Open_Source_Way

(Difference between revisions)
Jump to: navigation, search
(removing double-space after period; stub link to new article on writing sections)
(adding a useful category)
 
Line 38: Line 38:
[[Category:How to]]
[[Category:How to]]
[[Category:Documentation]]
[[Category:Documentation]]
 +
[[Category:Contributing to TOSW]]

Latest revision as of 13:27, 27 June 2012

This chapter explains how to write chapters in The Open Source Way book.

This book has a rhythm that is felt in the smallest sections and in the overall structure: principle, implementation, example.

There are a few chapters that explain important principles, extracted in a way to be applicable to a wide set of domains. These are currently: Communities of practice, How to loosely organize a community, Stuff everyone knows and forgets anyway, What your organization does correctly when practicing the open source way, and What your organization does wrong when practicing the open source way.

There are a few chapters that explain how to implement those principles in other fields (domains). These currently are: Business the open source way, Marketing the open source way, IT the open source way, and Law the open source way, and How to tell if a FLOSS project is doomed to FAIL.

There are a few chapters that show examples how individual implementations of the principles have worked. These currently are: Great stories to tell, Books you should read, and Data and references.

Within each of these chapters, the same rhythm is followed. In the chapters on important principles, each section presents a single principle, useful implementation information, and a brief example from the real world of implementing the principle. Read Section writing methodology for details of how to use these elements within a chapter.

In the chapter Great stories to tell, each story has a list of links back to the principles that are covered in the story, and links to the implementation chapters where relevant.

Principle chapters

Ideally these remain limited in number, only adding an entirely new chapter to cover a different perspective at this primary level.

Implementation chapters

The number of these chapters is limited by the number of domains of human knowledge and practice.

An important part of these chapters is that they note where they deviate or modify one of the primary principles.

Some domains may create new principles that don't apply as equally outside of the domain. Those sort of principles ideally have an analogue in the principles chapters, and if not, a close relationship.

Example chapters

These are all real world references in some way.

  • Specific reference materials;
  • Books to read;
  • Data resources;
  • Other scientific resources;
  • Anecdotes that demonstrate principle, implementation, and outcome;
  • Etc.
Personal tools