Skip to content

Monday, 11 May

Situation

  • I noticed that values for parameters are put in brackets.
  • "Warning:" strucures are allowed.
  • Also ":", also "()"

In this example - the "return track" is not capitalized: The original signal (which was received at Beat Repeat’s input) is mixed with Beat Repeat’s repetitions according to one of three mix modes: Mix allows the original signal to pass through the device and have repetitions added to it; Insert mutes the original signal when repetitions are playing but passes it otherwise; and Gate passes only the repetitions, never passing the original signal. Gate mode is especially useful when the effect is housed in a return track. Why?

  • Further more, release note structure is less rigid than the manual, leaving room for bullet point lists.
  • Problems with passive voice. Example: "In the dedicated Link page new features were added:". Passive voice.

Task

Aimed to update the rules of writing the documentation of the desired Live element. And improve writing to match release note format.

Fix passive voice.

Action

Updated the linter app and added that to the extract rules at the bottom of this report. Read the latest Release notes for Live 12.4 and 12.3 and extracted more style quides from there.

  • Taking more notes on passive voice

Result

Improved quality and accuracy of replicating the format.

Defining clearly between Release note format and Manual format

  • New info: "In the dedicated Link page new features were added:". Passive voice. The subject ("new features") is receiving the action rather than performing it.

Found a gimmik to see if a text is passive voice or not

The zombie test:

"Two noise types are included in Erosion by zombies" — grammatically fine, so it's passive.

"Erosion includes two noise types by zombies" — doesn't work, so it's active.