WikiPages

Organize pages in the wiki
This simple page, which at the moment is just a sketch, wants to bring together the threads that are dispersed in the forum and try to make order. I hope someone will add the contents that serve to better organize the wiki.

Purpose and principles
...

Outcome
...

Brainstorming
On this page

Organizing
...

Next actions

 * 1) gather ideas
 * 2) build Table of Contents
 * 3) build good models (in the template created by Wandererfan)
 * 4) edit the master page in English (updated until a new FreeCAD version is released then freeze the document in pdf or doc or other)
 * 5) translate (updated until a new FreeCAD version is released then freeze)
 * 6) continue to develop the documentation for the new version of FreeCAD (repeats 4)
 * 7) continue to develop the translation for the new version of FreeCAD (repeats 5)

Content and Appearance:

 * Content of pages (only useful things, depending on the type of user and type of document, without unnecessary duplication)
 * Appearance of the pages (pages clean, neat, easy to read, professional?)
 * Renato: width of the page, now much space is unused (only for monitor 16:10)
 * Renato: white background, text more readable

Style page

 * Code
 * Renato:  Description in the text box or follows? Compare Draft_Dimension and Draft_Dimension/it
 * Screen capture
 * Renato:  From Windows or Linux system? And with which theme?
 * Key
 * Renato:  Useful, but use it only once per type on a page
 * Task
 * Renato: serve but too many disturbing reading
 * See also
 * Renato:  links to similar commands, similar tools, scripts, examples, discussions, insights, forum, other... On all pages or only on some pages?
 * Template found (versions disordered, see Wiki_Template_List, some rarely used)
 * Clear
 * Click
 * DASH
 * Disambig
 * Docnav
 * FALSE FALSE      FALSE      FALSE       False   False  False   False  false
 * GuiCommand
 * Information
 * KEY
 * Languages
 * Macro
 * Message
 * VeryImportantMessage
 * Prettytable
 * PropertyView VIEW Property  View Property
 * Properties Title
 * PropertyTasks
 * Screenshot
 * Softredirect
 * TasksTag
 * TRUE
 * UnfinishedDocu
 * Version
 * Template that would be useful

Forum

 * Reflect on requests for help made ​​in the forum and use the given examples (if it is required an aid often means that the manual is not exhaustive, in the forum there are good examples, but hard to find)
 * Renato: Insert a link on the document page or insert the example or insert nothing?
 * Ralf: insert link(s) always in a field/area which is always there on every page. If there is nothing to link, there should be a text in this area as "There is currently no link to forum examples."
 * Ralf #2 examples: no examples at pages which are describing more than exactly the use of (probably mostly) a tool. If there would be examples (at different pages) which differ in various ways and are not comparable are confusing.
 * Ralf #3 examples: But beside of existing examples: defining a "standard model" (or some of them if needed for fairly different tasks as p.e. Part-Design vs. Arch) for really every example would promise a lot of advantages. The first one: if one like to try an example the related model file is available right there with the next click. Whatever the "standard model" could be - the most important condition it have to be usable for all examples/task from to simplest up to the most complex (FEM,assembly?!)
 * May be such an standard model and his incarnations could be also a kind of a "figurehead" for FC.

Documentation structure:

 * Links between pages (tree and hierarchy linear, orderly, full)
 * Renato: If there is an index the docnav does not serves.
 * Page titles descriptive
 * Renato: Translated or not translated? With the new translator seems outdated
 * Structure of the documentation (depending on the type of user and the type of documentation). Group some things?:
 * Reference (needs indicate precise criteria) (Ralf: for me for advanced users/using, #3)
 * How to (Ralf: additional, #4)
 * Tutorial (Ralf: additional, #5)
 * External links
 * Themed (Ralf: 1st thing / start point while using the documentation? - for me #1)
 * examples - in relevant cases - the most basic example for using the tool / workbench /feature (is that possible with complex tools?) ; may be one "standard" example case for the most examples, if possible (so the fcstd file can be supplied and re-used for a lot of uses) for me #2 or to #1
 * linear (all, as now)
 * structured with sub-structures (very clear if there are no more than 5..7 entrys per structure layer)
 * task - specific (features is other than transform than handle mouse etc.)
 * FAQ
 * Books
 * Plugins
 * Macro

Documentation schemes

 * Scheme 1 based on the type of users (for example, to modify)

DOC |--users |   |---overview FreeCAD |   |   |--aa |   |   |  |--page1 |   |   |  |--page2 |   |   | |    |   |--ab |   |      |--page1 |   |      |--page2 |   | |    |---getting started |       |--mouse model |       |--2D |       |  |--drawing objects |       |  |--modifying objects |       |  |--utility tools |       |  |--____ |        |   |        |--3D |       |  |--primitives |       |  |--modifying objects |       |  |--_______ |        |  |--________ | |--power users |   |--Pivy |   |--script | |--developers |   |--compiling |   |--modifying | |--install, license, ...


 * Scheme 2 based on the type of documents (for example, to modify)

DOC |--reference |   |---workbench a |    |   |--command a |    |   |  |--intro |   |   |  |--image |   |   |  |--how to use |   |   |  |--option |   |   |  |--see also |   |   |  |--link |   |   |  |--script |   |   |  |--macro |   |   |  |--dev info |   |   | |    |   |--command b |    |      |--ab1 |   |      |--ab2 |   | |    |---workbench b |        |--ba |       |--bb | |--user manual |  |--navigation |  |--manipulators |  |--preferences |  |--placement |  |--______ | | |--tutorials | |--books | |--FAQ |  |--install |  |--use | |--Show your FreeCAD projects here! archives

todo
 * Scheme 3 mixed (for example, to modify)

Repository

 * fcstd file
 * pics, images
 * icons (there are almost all)
 * "Show your FreeCAD projects here!" archives

Who are the users:

 * New users FreeCAD:
 * Users without CAD experience -> not the job of the FreeCAD doc to teach them CAD - the job to teach them how to use FreeCAD?
 * Users with CAD experience (2D/3D/parametric); users with 3D experience - no CAD
 * Users who know how to program (version?)


 * Users who know FreeCAD:
 * Users
 * Advanced users
 * Developers

What the users needs:

 * According to the category of the previous point they need different things (to be determined).
 * Renato: In my opinion the beginners to FreeCAD (or to CAD?) needs:
 * find the information immediately + Ralf: in the expected, consistent way
 * know what are the workbenches, when and how to use them, + Ralf: is this one workbench all I need or do I need more than one?
 * the commands that are available, + Ralf: in the workbench - for the task - all
 * the workflow to use, - Ralf: workflow sounds specific - may be the most basic way to use this - may be especially for tools there could be more than page per tool (as above: basic for beginners, extended use for advanced users)

Contributions

 * Rules to be respected - Previously defined in "Style page".
 * use of: TOC, KEY, TASK, VIEW Macros, tags, navigation bar, GuiCommand box, thumbnails, illustrations,  screenshot, Image Sizes, ecc.., (normandc wrote:... the tags are distracting and should not be used so much in the command reference pages....navigation bar is not very useful, since the toolbar is just a click away, in the workbench page which is linked in the GuiCommand box, which also includes a "See also" field.)
 * content of the texts.

Translations
''- The wiki, is the best way to create documentation FreeCAD? Would not it be better to reserve it for some issues and create a comprehensive manual for each version?'' ''- About updates, this is a crucial point, I've seen that you do not like docboock, and I do not intend to return to this theme, but docboock allows translators to easily work on documents. Allows you to download the entire document and compare it with the previous one. With this way changes are made always and only in the original document. Then the translators periodically (even daily if they want) downloading the document and compares with an earlier version and update it indicating the upgrade version. I've experienced that this procedure is very good. Can I do a similar thing with the wiki? In this way there is no need to continuously monitor Recent Changes and updates are easier to control.''
 * Consistent (the reference page is the English page, see the various discussions regarding the rules in the forum)
 * Updated (how?) + Ralf: 1st: Version, 2nd: frozen state of doc page - "this is the actual version of the documentation of ... for FC version xxx"; 3rd linked archiv pages of other versions (and maybe other frozen states), all with corresponding "tags" / marks
 * Use a document type that including at least one complete section of the manual (not just one page at a time). Comparable off line with an previous version. With "Recent changes" is difficult to follow all the changes, when they are frequent.
 * FCSTD files for Documentation (wandererfan wrote: It would be nice to have a repository for the fcstd files +Ralf and it would be very helpful - used to generate screenshots, etc. Then the 2nd author/translator could just open the fcstd with a different locale to generate the new screenshot. This would also for standardization of background colours, font sizes, etc. )
 * Renato. My personal:

Some notes taken from the forum
yorikvanhavre wrote: Actually we could do a little brainstorming, see things that should be changed on the wiki... I already thought of a couple of things: - a new wiki homepage with a clear view of the contents - better formatting of the 3 principal sections, for user (basically the command pages), for power users (everything about python) and the higher-level stuff (compiling, etc) - more professional aspect of the wiki pages - build a better and more strict model for command pages - find a good system to handle translations

gdo wrote: But maybe a survey to freecad users could help to understand precisely what is the beginners needs.

Ralf wrote: Even for the ones who are trying FreeCAD the first times, it's essential to find a consistent documentation otherwise they weren't motivated to give even some first tries.

And many more ... dispersed and mixed in: http://sourceforge.net/apps/phpbb/free-cad/viewtopic.php?f=8&t=3167 http://sourceforge.net/apps/phpbb/free-cad/viewtopic.php?f=10&t=3899 http://sourceforge.net/apps/phpbb/free-cad/viewtopic.php?f=8&t=3988 http://sourceforge.net/apps/phpbb/free-cad/viewtopic.php?f=12&t=3959 http://sourceforge.net/apps/phpbb/free-cad/viewtopic.php?f=13&t=4025

Links to FreeCAD pages
GuiCommand_model Boiler_NonCommand Wiki_Template_List Wiki_Resources Template:UnfinishedDocu

Examples of CAD documentation
http://help.solidworks.com/2013/English/SolidWorks/sldworks/c_Sketch_Fillets.htm?id=cb1f4dfbe23245aeb58d17af808ee10c#Pg0

Ralf: good: you can see where you are ; bad: a huge lot of entrys in the navigation / summary at left - the opposite of structured; sorry: pieces of the forum at the documentation page: what is the documentation page good for than? (but the link to the forum / forum search - ok.) http://www.gcad3d.org/ Ralf: thumbs up. clear, well structured. sometimes long but I don't know how to avoid that at some themes. Maybe the tree structure layers could be separated in two directions at the page for more place for the content. They have "last updates" I prefer "this version of the documentation is xxx and depend the program version xxy"

Reported by wandererfan guidelines for wiki authors: http://wiki.blender.org/index.php/Meta:Guides/Writer_Guide http://wiki.blender.org/index.php/Meta:Guides/Style_Guide Manual TOC: http://docs.gimp.org/2.8/en/ http://wiki.blender.org/index.php/Doc:2.6/Manual

Reported by Ralf: http://opensourceecology.org/wiki/FreeCAD

For the Italian translation also: http://tp.linux.it/