← All ideas
  • Published 7 Nov 2022

Use Blender (app) for its own documentation

With the coming development of Blender Apps, it could be possible to create the documentation of Blender within such an app.

Right now, one of the major problems with the docs is the gigantic effort to keep the docs up-to-date. Therefore, in writing the docs, one has to keep this in mind and so, for example, avoid adding too much global screen captures or annotations to those screen captures. One has to update all those images, every time something changes (somewhere else) in the interface.

The textual info of the docs could be contained in the Text Editor with references to the actual objects within the other Blender editors.

In the figure below, the Text Editor describes the Video Sequence Editor. The actual video editor window is right next to it. Both contain markers that are discussed in the text. proposal-blender-docs.png

The advantage of this approach is that the images from the usual docs are provided by the Blender program and therefore always up-to-date.

Because we can use a simplified version of Blender in the Blender apps, it could be possible to target the documentation to specific use cases (e.g. video sequencer, Grease Pencil, ...).

75%

Development Status: Open

Upvote 3 Downvote 1
hush
7 Nov 2022

0 Comments