WikiPages: Difference between revisions

From FreeCAD Documentation
No edit summary
(some additions)
Line 1: Line 1:
{{VeryImportantMessage|This section is under construction, for test.
{{VeryImportantMessage|Page in development.
There are no links that direct to this page.
I hope someone will correct this text.}}
I hope someone will correct this text.}}


Line 10: Line 9:
* Content of pages (only useful things, depending on the type of user and type of document, without unnecessary duplication)
* 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?)
* Appearance of the pages (pages clean, neat, easy to read, professional?)
** ''width of the page''
** Renato: ''width of the page, now much space is unused''
** ''white background''
** Renato: ''white background, text more readable''


==Style page==
* Code
** Renato: '' Description in the text box or follows?'' Compare [[Draft_Dimension/it#Script]] and [[Draft_Dimension#Scripting]]
* Screen capture
** Renato: '' From Windows or Linux?''
* Key
* Task
* See also
* ...



==Forum==
==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)
* 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?''



==Documentation structure:==
==Documentation structure:==
* Links between pages (tree and hierarchy linear, orderly, full)
* Links between pages (tree and hierarchy linear, orderly, full)
** Renato: ''If there is an index the docnav does not serves.''
* Page titles descriptive
* 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):
* Structure of the documentation (depending on the type of user and the type of documentation):
** Reference (needs indicate precise criteria) (Ralf: for me for advanced users/using, #3)
** Reference (needs indicate precise criteria) (Ralf: for me for advanced users/using, #3)
Line 36: Line 51:


* Users who know FreeCAD:
* Users who know FreeCAD:
** Users
** Advanced users
** Advanced users
** Developers
** Developers
Line 49: Line 65:


==Contributions==
==Contributions==
* Rules to be respected
* 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.)''
** 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.)''
** and content of the texts.
** content of the texts.


==Translations==
==Translations==
Line 58: Line 74:
** ''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.''
** ''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. )''
* 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. )''
* My personal:
* Renato. My personal:
''- 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?''<br>
''- 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?''<br>
''- 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.''
''- 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.''
Line 81: Line 97:


==Links to FreeCAD pages==
==Links to FreeCAD pages==
[[GuiCommand_model]]
[[GuiCommand_model]]<br>
[[Boiler_NonCommand]]<br>
[[Wiki_Template_List]]<br>
[[Wiki_Resources]]<br>
[[Template:UnfinishedDocu]]<br>


==Examples of CAD documentation==
==Examples of CAD documentation==
Line 91: Line 111:
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"
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<br>
{{languages | {{it|WikiPages/it}} }}
guidelines for wiki authors:<br>
http://wiki.blender.org/index.php/Meta:Guides/Writer_Guide<br>
http://wiki.blender.org/index.php/Meta:Guides/Style_Guide<br>
Manual TOC:<br>
http://docs.gimp.org/2.8/en/<br>
http://wiki.blender.org/index.php/Doc:2.6/Manual<br>


{{languages | {{|}} {{|}} }}


[[Category:Documentation]]
[[Category:Documentation]]

Revision as of 21:10, 13 May 2013

Page in development. I hope someone will correct this text.

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.

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
    • Renato: white background, text more readable


Style page


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?


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):
    • Reference (needs indicate precise criteria) (Ralf: for me for advanced users/using, #3)
    • How to (Ralf: additional, #4)
    • Tutorial (Ralf: additional, #5)
    • 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.)

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

  • 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:

- 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.


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


Available translations of this page: {{|}} {{|}}