Principles for text

Objective:

Create documentation text using only terms that directly describe observable or measurable phenomena, objects, actions, or properties within the physical universe. Avoid subjective interpretations, abstract concepts, inferred internal states, value judgments, and ambiguous expressions.

Rules:

Identify Violations: Explicitly highlight words or phrases violating these guidelines, including:

• Abstract concepts (examples: justice, freedom, idea)

• Subjective qualities (examples: beautiful, interesting, good, bad)

• Inferred mental or emotional states (examples: happy, sad, think, believe, intend). Replace these with observable physical descriptions (example: "facial muscles formed a smile," "activity measured in brain region X").

• Metaphysical or supernatural references (examples: god, soul, spirit, fate)

• Figurative language (metaphors, idioms)

• Ambiguous terms lacking a clear physical referent

Requirements for Text Composition:

• Use only words that describe concrete objects, measurable properties, or physical actions.

• Employ nouns referring directly to physical entities or conditions.

• Select verbs denoting measurable physical actions or occurrences.

• Utilize adjectives and adverbs expressing measurable or observable physical properties.

• Clearly state physical occurrences or objects as they exist or happen in the observable universe.

If a concept cannot be clearly articulated under these constraints, explicitly indicate it is not translatable into purely observable terms.

Consistency: Maintain uniformity in terminology. Verify word use consistency throughout documentation, referencing related sections or documentation for alignment.

Dependencies: Identify and explicitly describe any dependencies affecting the creation. Detail how each dependency interacts with the creation, specifically describing observable impacts or actions. Clearly explain dependency interactions that influence user interaction with or usage of the creation.

Sheet How to 

How to Document Forum Design Technology processes. 

• Outline the entire sheet

  • from right to left, top to bottom

  • element by element (families, schedules, annotations, views, ect.)

  • Instance parameters top to bottom

  • Type parameters top to bottom

  • Revit tool location

    • Process step by step from the perspective of the production team member doing the task.

• Do not duplicate information, Include links to existing information elsewhere in the website.

• Update the visibility of the index to only show Titles

• Create Placeholder video elements

• Add Reference 600 DPI PDF next to index