[Bf-docboard] Proposal for restructuring the user manual

Pep Ribal pepribal at gmail.com
Sun Dec 28 00:14:43 CET 2014


Hi,

if you are suggesting to make an editor-by-editor documentation, I think 
that you are talking not about a Blender manual, but about a Blender 
Reference.

I completely agree with you that this would be really good to have, but 
it's not a manual restructure. It's a new thing. Manual is, and should 
stay IMHO, topic-driven. A reference should be editor-driven.

However, I think it's important to focus on having an accurate and 
up-to-date manual now. If this is accomplished, I completely support the 
Blender Reference idea.

Regards,

Pep.

El 27/12/14 a las 22:18, Gaia escribió:
> Hi;
>
> I would like to propose some small first steps for beginning the 
> restructuring of the first 2 levels of the documentation hierarchy:
>
> A bit of reasoning for why i propose this:
> I guess that most people will first open the program, then open the 
> documentation, and try to find their way. Since Blender uses the 
> Editors all over the place, i think it is convenient to take care of 
> this in the manual as well. So for example a user should not need to 
> guess where he/she could possibly find something about the UV Image 
> editor. But get this presented right away in the hierarchy. That's why 
> i propose to add an "Editors" Section on the first documentation level.
>
>   * Basics <http://www.blender.org/manual/basics/index.html>
>       o Introduction
>         <http://www.blender.org/manual/introduction/index.html>
>       o Installation
>         <http://www.blender.org/manual/installing_blender/index.html>
>       o First Steps (a Walk through video
>         <https://www.youtube.com/watch?v=COUWLINzj-s&index=1&list=PL7541C8D8005D6E53>)
>       o Concepts
>           + 3D Interaction
>             <http://www.blender.org/manual/3d_interaction/index.html>
>           + Interface <http://www.blender.org/manual/interface/index.html>
>
>   * Editors
>       o 3D View
>       o Timeline
>       o Graph Editor
>       o Dope Sheet
>       o NLA Editor
>       o UV Image Editor
>       o Video Sequence Editor
>         <http://www.blender.org/manual/sequencer/index.html>
>       o Movie Clip Editor
>       o Text Editor
>       o Node Editor
>       o Logic Editor
>       o Properties Editor
>       o Outliner
>       o User Preferences
>         <http://www.blender.org/manual/preferences/index.html>
>       o Info Window
>
>   * Functional areas
>       o Import/Export (taken away from the Data System section)
>       o Modeling <http://www.blender.org/manual/modeling/index.html>
>       o Materials <http://www.blender.org/manual/materials/index.html>
>       o Textures <http://www.blender.org/manual/textures/index.html>
>       o World <http://www.blender.org/manual/world/index.html>
>       o Physics <http://www.blender.org/manual/physics/index.html>
>       o Modifiers <http://www.blender.org/manual/modifiers/index.html>
>       o Animation <http://www.blender.org/manual/animation/index.html>
>           + Rigging <http://www.blender.org/manual/rigging/index.html>
>       o 2D
>           + Rendering <http://www.blender.org/manual/render/index.html>
>           + Compositing
>             <http://www.blender.org/manual/composite_nodes/index.html>
>           + Motion Tracking
>             <http://www.blender.org/manual/motion_tracking/index.html>
>             (maybe this is NOT 2D)
>           + Grease Pencil
>             <http://www.blender.org/manual/grease_pencil/index.html>
>       o Constraints <http://www.blender.org/manual/constraints/index.html>
>
>   * Advanced
>       o Data System <http://www.blender.org/manual/data_system/index.html>
>       o Game Engine <http://www.blender.org/manual/game_engine/index.html>
>       o Extending Blender
>         <http://www.blender.org/manual/extensions/index.html>
>
>   * Troubleshooting
>     <http://www.blender.org/manual/troubleshooting/index.html>
>
>   * Glossary <http://www.blender.org/manual/glossary/index.html>
>
> It may be possible that the "Functional Areas" and the "Editors" are 
> just 2 different views on the same topic.
> Thanks for reading up to here :)
> -gaia-
>
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> http://lists.blender.org/mailman/listinfo/bf-docboard

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.blender.org/pipermail/bf-docboard/attachments/20141228/a9864864/attachment.htm 


More information about the Bf-docboard mailing list