Page MenuHomeFreeBSD
Files F107804530

D34486.diff
No OneTemporary
Actions

D34486.diff
View Options

diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc
--- a/documentation/content/en/books/fdp-primer/overview/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc
@@ -57,11 +57,46 @@
This primer shows how to:
+* Understand the role of documentation and its place in the ecosystem.
* Identify which parts of FreeBSD are maintained by the FDP.
* Install the required documentation tools and files.
* Make changes to the documentation.
* Submit changes back for review and inclusion in the FreeBSD documentation.
+[[overview-documentation-ecosystem]]
+== Documentation in the FreeBSD Ecosystem
+
+All documents are for the benefit of their readers, not their writers or caretakers.
+They should adapt to the reader and not expect the reader to adapt to them.
+
+Never blame the reader for:
+
+* being unable to make use of a document easily or at all
+* finding a document confusing
+* not understanding a document or how to apply it
+* not finding an explicit answer or successfully bridging gaps (or connecting dots) to reason their way to one
+
+Instead, acknowledge that the document is:
+
+* inaccessible
+* confusing
+* hard to understand or apply
+* incomplete
+
+Then, make the document:
+
+* more accessible
+* less confusing
+* clearer
+* more complete
+
+Use the following methods:
+
+* apply link:https://webaim.org/intro/#principles[accessibility best practices] to correct the problem reported and any similar ones you find
+* rework or clarify the confusing structure or language
+* add relevant examples to the part that is hard to understand or apply
+* fill in the gaps or add the missing stepping stones
+
[[overview-quick-start]]
== Quick Start

File Metadata

Mime Type
text/plain
Expires
Sun, Jan 19, 7:51 AM (20 h, 58 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
15935026
Default Alt Text
D34486.diff (1 KB)

Event Timeline