Date: Fri, 29 Mar 2024 16:19:29 +0100 (CET) Message-ID: <1623605506.17984.1711725569365@09e9d69a2016> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_17983_668962738.1711725569364" ------=_Part_17983_668962738.1711725569364 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Reduce the amount of docu= ments with overlapping information. Also divide the concerns regarding the = formatting and - as far as possible - the structure from the content. Whene= ver there are different aspects, consider if handling them independently wo= uld make things easier.
Separate a documentation into distinct sections such that each section addresses a separate conce= rn. A concern is a set of related inf= ormation.
Let me try to explain to you, what to= my taste is characteristic for all intelligent thinking. It is, that one i= s willing to study in depth an aspect of one's subject matter in isolation = for the sake of its own consistency, all the time knowing that one is occup= ying oneself only with one of the aspects. We know that a program must be c= orrect and we can study it from that viewpoint only; we also know that it s= hould be efficient and we can study its efficiency on another day, so to sp= eak. In another mood we may ask ourselves whether, and if so: why, the prog= ram is desirable. But nothing is gained =E2=80=94on the contrary!=E2=80=94 = by tackling these various aspects simultaneously. It is what I sometimes ha= ve called "the separation of concerns", which, even if not perfectly possib= le, is yet the only available technique for effective ordering of one's tho= ughts, that I know of. This is what I mean by "focussing one's attention up= on some aspect": it does not mean ignoring the other aspects, it is just do= ing justice to the fact that from this aspect's point of view, the other is= irrelevant. It is being one- and multiple-track minded simultaneously.
E= dsger W.Dijkstra. On the role of scientific thought. 1974
Each document is based on three components: contents, structure, format.=
These there concerns must all support the topic described in the documen= t, but may require a different expertise. Typically not each team member is= good at all of these aspects equally. Therefore there should be tools to s= upport the team member to concentrate on one at a time. For instance a blue= print and style sheets take care of the basic structure and the formatting = styles. Relying on these tools, the author can concentrate on the content t= o deliver the information. The structure and format may none-the-less be fi= ne-tuned by the author to further support the information.
The following practices are related to this principle.
The following principles are related to this principle.
More information on this principle.