Blender Power Sequencer docs
Source repository for Power Sequencer, the Open Source Blender add-on for video makers.
To read the documentation, head to the add-on's GitHub wiki . We use this repository to write the documentation with other contributors and collect videos.
Docs writing guidelines
Documenting a tool in the docs doesn't take much time and helps up tremendously! If you enjoy using Power Sequencer, it's a great way to contribute to the project.
We follow a few guidelines to make sure the content is well-structured and as clear as can be. They're the same as the Godot engine's docs writing guidelines :
- Use the direct voice instead of the passive voice
- Use precise action verbs
- Avoid verbs that end in -ing
- Remove unnecessary adverbs and adjectives.
- Ban these 8 words: obvious, simple, basic, easy, actual, just, clear, and however
- Use explicit references
- Use ‘s to show possession
- Use the Oxford comma
In short, we favor simple English, a coherent structure and short sentences to make the docs more pleasant to read.
How to write docs for a given feature
- Use h2
##for the first title and h3
- Start with the title, a short description, followed by a 480p screen recording and the steps to use the tool
- Use the html
<kbd></kbd>tag for keystrokes. Don't put spaces between keyboard tags. E.g. for Shiftc write
If you need more info, a review, or help to record the video demo, count on us! You can open an issue on GitHub, or contact GDquest on Twitter .
Regex to add
kbd tags around keyboard shortcuts:
- Emacs sed command ->
s/\( ?\(Shift\|Ctrl\|Alt\|Action Mouse\|Select Mouse\|F[0-9]\|[A-Z0-9]\) ?\)/<kbd>\2<\/kbd>/g
- Davide Cristini
- Nathan Lovato
- Nathan Lovato ( GDQuest )