Page MenuHome

Blender Manual Writing Guide renewal proposal
AbandonedPublic

Authored by Tuomo Keskitalo (tkeskita) on Dec 7 2018, 12:54 PM.

Details

Summary

As mentioned in D4015#91200, the number of writing and markup guidelines for Blender Manual editors is currently very large and not clear in all places, so here is my attempt at condensing the writing guide part. Any comments? @Aaron Carlisle (Blendify), @Tobias Heinke (TobiasH), @Inês Almeida (brita_), @Brecht Van Lommel (brecht) , anyone else?

Related differentials: D4015, D4041

Diff Detail

Repository
rBM Blender Manual

Event Timeline

Seems all reasonable to me, but would be good if someone more active in the manual would look at this.

manual/about/contribute/guides/writing_guide.rst
23

Aim -> The aim

37

from the manual style

38–41

I don't think every deviation needs to be commented, maybe only in a few rare cases. Would not have this as a rule.

56

Avoid documenting -> Don't document

59

or include them -> or included

62

for user -> for the user

72

Glossary section -> The glossary section

75

meaning -> the meaning

78

term -> the term

Tobias Heinke (TobiasH) requested changes to this revision.Dec 12 2018, 12:04 AM

I could add a comment to almost ever single line (Why are you: altering the meaning, remove examples/explanations, the reshuffling, removal of rules..)
You're turning it into a cheat sheet.
Yes, it improves the wording. I'm sorry but your not experienced enough (yet) to rewrite the guide.

For me it has no high priority, so I'll add this to my todo list.