Skip to content

Commit 490e20e

Browse files
committed
feat: update documentation with new rules, corrections, and improved clarity across multiple sections
1 parent b3f2fe4 commit 490e20e

10 files changed

Lines changed: 98 additions & 41 deletions

File tree

docs/Extracted_Rules/Extracted_Rules.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,42 @@
99
8. Software name capitalisation — Live (the software) and version refs like Live 12 are always capitalised.
1010
9. Grammar: allows/enables to — allows to and enables to are grammatically wrong. Use allows you to or lets you.
1111
10. Paragraph length — Max 4 sentences per paragraph. (Not enforced in Free mode)
12-
11. Passive voice — Avoid was added, has been updated, can be accessed. Use active voice.
12+
11. ~~Passive voice — Avoid was added, has been updated, can be accessed. Use active voice.~~
1313
12. Bug fix structure (Bug Fix mode) — Must describe both: what broke AND what now works.
1414
13. Release note structure (Release Note mode) — Must lead with what the user can now DO.
1515
14. Minimize words — Cut simply, just, easily, obviously, of course, clearly — they make tasks sound trivial.
1616
15. Weak sentence opener — Avoid starting sentences with There is/are or It is. Lead with the real subject.
1717
16. Redundant phrasing — in order to → to, due to the fact that → because, at this point in time → now, etc.
18-
17. Filler phrases — Cut please note, note that, it is worth noting, as you can see, etc.
18+
17. ~~Filler phrases — Cut please note, note that, it is worth noting, as you can see, etc.~~
19+
20+
> **correction**: Note that is allowed
21+
1922
18. Double spaces — Single space between words and after punctuation.
2023
19. Trailing ellipsis — ... at the end of a sentence implies an unfinished thought.
2124
20. Avoid etc. — Complete the list or write and
2225
21. Parameter Values - place parameter values in double quotes. 100% is "100%".
2326

2427
**Release Note Only**
28+
2529
1. Release note structure — must describe what the user can now DO (looks for: "can now", "lets you", "allows you", "use", "select", "access", etc.)
2630

2731
# Bug Fix Rules
2832

29-
1. Always lead with "Fixed" — "Fixed an issue where...", "Fixed a bug where...", "Fixed a crash that occurred when..."
33+
1. ~~Always lead with "Fixed" — "Fixed an issue where...", "Fixed a bug where...", "Fixed a crash that occurred when..."~~
34+
35+
> **correction**: those are suggestions ...
36+
3037
2. Platform-specific bugs — name the platform first. "Fixed an issue on macOS where...", "Fixed an issue on Windows where..."
3138
3. Describe the trigger — what action or condition caused the bug. Be specific.
3239
4. Describe the outcome — what now works. Can be a second sentence: "X now Y."
3340
5. Passive voice IS allowed here — "Fixed an issue where X was not Y" is the standard form. The linter skips passive checks in Bug Fix mode.
3441
6. Use bullet points for multiple related fixes in the same release.
35-
7. No crash without a trigger — "Fixed a crash" alone is not enough. State what caused it.
36-
8. All standard rules still apply — American English, UI element caps, no marketing, no dev jargon, no contractions, acronym caps, etc.
42+
7. ~~No crash without a trigger — "Fixed a crash" alone is not enough. State what caused it.~~
43+
44+
> **correction**: those are suggestions ...
45+
46+
8. All standard rules still apply — American English, UI element caps, no marketing, no dev jargon, no contractions, acronym caps, etc.
47+
48+
9. Max 2 sentences.. or as short as possible.
49+
50+
10. Improvements, features and more - start with the main subject instead of "Fixed"

docs/Extracted_Rules/Update_Log.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Update Log
22

3-
- 11 May — added rule nr. 21 "Parameter Values"
3+
- 17 May - Added Bug Fix rules 9. and 10.
4+
- 16 May - Added corrections on Bug Fix rules 1., 7. and on General rule 1.
5+
- 15 May - Flagged 11. Passive voice and crosses it out.
6+
- 11 May — Added rule nr. 21 "Parameter Values"
47
- 09 May — Created the Rules list

docs/Git/Git_Learning_Notes.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Git Notes
22

3-
Stuff I actually did and understand. Short form.
3+
Stuff I actually did and understand :)
44

55
---
66

77
## Mental model
88

9-
- branch = full snapshot of repo, not a folder
9+
- branch = full snapshot of repo, not a folder...
1010
- commit = photo of every file at one moment, has a hash
1111
- branch label = sticky note pointing at one commit
1212
- `HEAD` = "you are here"
@@ -40,7 +40,7 @@ git add Writing_Rules/Writing_Rules.md # stage
4040
git commit -m "feat: add more writing rules" # commit
4141
```
4242

43-
forgot to stage once got "nothing to commit, working tree clean"
43+
I forgot to stage once and got "nothing to commit, working tree clean"
4444
`git status` shows it. red = unstaged, green = staged.
4545

4646
### unstaging
@@ -51,7 +51,7 @@ git restore --staged <file> # undo a git add
5151
### undoing commits
5252
```
5353
git reset --soft HEAD~1 # undo last commit, keep changes staged
54-
git reset --hard HEAD~1 # undo last commit + delete changes ⚠️
54+
git reset --hard HEAD~1 # undo last commit + delete changes
5555
```
5656

5757
`HEAD~1` = one commit back
@@ -69,8 +69,13 @@ git merge writing-rules # pull writing-rules into main
6969
git push
7070
```
7171

72-
merge opened Vim asking for a message. exit Vim: `Esc`, then `:wq`, Enter.
73-
my merge used the 'ort' strategy = true merge with a merge commit (not fast-forward).
72+
merge opened Vim asking for a message. Vim = a text editor inside the terminal. no mouse, only keys.
73+
exit Vim: `Esc`, then type `:wq`, Enter. (`:wq` = save and quit)
74+
75+
my merge said it used the 'ort' strategy. from what I get so far:
76+
- if nothing new is on `main`, git just glues the new commits on the end → no message needed
77+
- if both branches have new stuff, git makes one extra commit to join them → that's what needed a message
78+
- 'ort' is just the name of the recipe git uses to combine them. don't really get the details yet, still looking into it.
7479

7580
### deleting a branch (local only)
7681
```

docs/Journal/16_May.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,19 @@
22

33
## Situation
44

5+
End of the week and I'm barely using AI anymore. It keeps getting the rules wrong, and I spend most of the time denying its suggestions instead of accepting them.
56

67
## Task
78

9+
Trust you instinct an stop using help.
810

911
## Action
1012

13+
AI — started the week using it as a learning tool, which worked. But by now its facts about the rules are off enough that I'm correcting more than I'm getting. Pulled back on checking with it.
1114

1215
## Result
1316

17+
- My writing is consistenly right the first time.
18+
19+
---
20+

docs/Journal/17_May.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
11
# Sunday, 17 May
22

33
## Situation
4-
4+
Numbers written as digits in places they shouldn't be. Bug entries and improvement entries blending into each other. Also wanted to spend time on git outside of just using it for commits.
55

66
## Task
7-
7+
Pin down new small rules — number style, bug entry shape, improvement entry shape. Practice git and start a dedicated git page in the docs.
88

99
## Action
10+
Numbers — should be spelled out. "three" not "3". At least for low numbers in prose.
11+
12+
Bug entries — always start with "Fixed". Two shapes I keep seeing:
13+
- `Fixed [device] [problem]` — e.g. "Fixed Drum Sampler crash on load."
14+
- `Fixed [adjective] [noun]` — e.g. "Fixed incorrect parameter naming."
1015

16+
Improvements / features — lead with the improved thing, not the action. The feature is the subject.
17+
18+
Git — practiced branching, merging, and pushing on the side. Made a Git page in the docs to write down what I actually understand.
1119

1220
## Result
21+
Three small rules locked in:
22+
23+
1. Numbers spelled out ("three", not "3").
24+
2. Added a new rule in the Bug Fix section (rule 9 and 10)
25+
3. New Git page in the docs — notes from actual use, not copy-pasted commands.
26+
27+
---
1328

docs/Manual/00_manual.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Live 12 Manual
22

3-
This site is an **example and mockup** of the manual I would write for Ableton Live.
3+
Here you can preview an **example and mockup** of the manual entries I would write for Ableton Live.
4+
45
It’s intended for interview purposes: to demonstrate structure, tone, and how I would explain workflows, fixes and improvements.

docs/Questions & Notes/Notes.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# Notes
22

3-
1. Duplicate!
3+
1. Duplicate Found!
44

55
```
66
Fixed an issue where it was not possible to navigate back to the Splice label with the Browse Back and Browse Forward buttons after navigating to other labels in the browser. This change also makes it possible to use these buttons to navigate to the Cloud label even when Cloud is not authorized, as well as to the Max for Live label even when Max is not available.
77
```
8+
9+
2. Bug Found in Live 12.4 Suite
10+
11+
Using the Control / Command + J keyboard shortcut for joining clips while the Audio Engine was off is not working.

docs/Questions & Notes/Questions.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Questions
22

3-
### 1. In this example - the **return track** is not capitalized:
3+
### Question 1
4+
5+
In this example - the **return track** is not capitalized:
46

57
```
68
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.
@@ -11,7 +13,9 @@ The original signal (which was received at Beat Repeat’s input) is mixed with
1113

1214
---
1315

14-
### 2. Does Wander continuously generate a new random signal (smooth, unsynced, always moving), or does it produce a new random shape once per LFO cycle?
16+
### Question 2
17+
18+
Does Wander continuously generate a new random signal (smooth, unsynced, always moving), or does it produce a new random shape once per LFO cycle?
1519

1620
```
1721
Select one of the following LFO waveforms via the Wave drop-down: Sine, Triangle, Ramp Up, Ramp Down, Square, S&H (Sample and Hold), or Wander. You can further shape the selected waveform using the Morph slider.
@@ -22,7 +26,9 @@ Select one of the following LFO waveforms via the Wave drop-down: Sine, Triangle
2226

2327
---
2428

25-
### 3. What does Morph specifically transform for each wave shape? For example — does it change pulse width on Square, skew the peak on Sine, bend the slope on Triangle?
29+
### Question 3
30+
31+
What does Morph specifically transform for each wave shape? For example — does it change pulse width on Square, skew the peak on Sine, bend the slope on Triangle?
2632

2733
```
2834
Select one of the following LFO waveforms via the Wave drop-down: Sine, Triangle, Ramp Up, Ramp Down, Square, S&H (Sample and Hold), or Wander. You can further shape the selected waveform using the Morph slider.
@@ -33,23 +39,9 @@ Select one of the following LFO waveforms via the Wave drop-down: Sine, Triangle
3339

3440
---
3541

36-
### 4. Is future passive voice permitted?
37-
38-
```
39-
You will then be prompted to select a tag group or parent tag for the newly created tag. Type the name of an existing tag group or parent tag, or type your desired name and select either the Create new parent tag… or Create new tag group… option.
40-
```
41-
42-
Also here:
43-
44-
```
45-
Note that this mode is not yet implemented in Live, but is expected to be implemented in a future update.
46-
```
47-
48-
- [Release Notes Live 12.4](https://www.ableton.com/en/release-notes/live-12/)
49-
50-
---
42+
### Question 4
5143

52-
4. How can we decide what tense we use?
44+
How can we decide what tense we use?
5345

5446
```
5547
The filter decay in Drum Sampler's 8bit effect can now be disabled by turning the decay parameter all the way up.

docs/Release_Note/00_release_notes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
55
## About This Document
66

7-
This document includes mockup release notes for Ableton Live 12.4.
7+
This document includes mockup release notes for Ableton Live 12.4 and 12.3
88

99
## How to Use This Document
1010

11-
- Use the navigation on the left to jump to a specific version.
11+
- You can use the navigation on the left to switch to a specific version.
1212
- Each version section lists new features, improvements, and bug fixes.
13-
- Screenshots and diagrams are included where relevant to help illustrate changes.
1413

1514
## Versions Covered
1615

17-
Live 12.4
18-
Live 12.3 - partially
16+
- Live 12.4
17+
18+
- Live 12.3 (partially)

docs/index.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@
33

44
Hello, my name is Theodor, and I created this website as a way to present my progress for the interview for the Technical Writing position at Ableton.
55

6-
Has multiple sections which a journal, questions, a exercises I have done, release notes and everything I could think of. You can navigate through this website using the sections present on the top of your screen or on the top left - marked by three horizontal lines - depending on your window size.
6+
It has multiple sections:
7+
8+
- Manual
9+
10+
- Release Notes
11+
12+
- Old Versions / First Practice
13+
14+
- Git & Github
15+
16+
- Journal
17+
18+
- Extracted Rule
19+
20+
- Questions & Notes
21+
22+
You can navigate through this website using the sections present on the top of your screen or on the top left - marked by three horizontal lines - depending on your window size.
723

824
Thank you :)

0 commit comments

Comments
 (0)