User Manual Guidelines

From Inkscape Wiki
(Redirected from Manualguidelines.html)
Jump to: navigation, search

the manual is divided in several parts.

  • Introduction
  • Menus and command list and description
  • Learning and thematic texts

Structure is : Book

  chapter
     sect1
        simplesect
           para
           lists
           procedure

A sect1 is the part corresponding to one command, tool or menu. Each sect1 should have :

  • a title
  • an entry picture, icon view or screenshot
  • an introduction (functionnality description and goal)
  • the places is can be activated (menus, shortcut, command bar)

eventually :

  • procedures i.e. simple step by step production example
  • Modifiers descriptions
  • More infos and relations to other tools
  • Extras internal or external links

to find a template of sect1 go to SVN and get the user_manual/trunk/xml/sect1sample.xml