← Back to team overview

kicad-developers team mailing list archive

Re: Kicad future documentation - your opinion


I have never found the manuals to be very useful. The pdf format seems
ok to me though. A wiki format makes it easier for people to contribute
small changes but then you enter the spam wars...

The biggest lack in my opinion is an overview of how all the programs
fit together, and the models or concepts of how they each work. A
description of the eeschema->cvpcb->pcbnew workflow with some examples.

The new user will either be some hobbyist new to PCB design, and need an
overview of the basics of using kicad tools to solve typical problems,
or they will be people with experience in other tools, and need an
overview of how do translate their workflow to a kicad workflow.

Some articles worth checking out:



On 22/09/2011 12:04 p.m., fabrizio wrote:
> Hello,
> Now that the new 26pth kicad icons are basically finished (I'll maybe
> send reviews of some of them if necessary) I'd like to bring up the
> topic of documentation.
> As far as I understand Kicad has some manuals written in OpenOffice
> and a one step by step tutorial. On top of that there are the
> translations of them, all done in OpenOffice.
> Before the new face-lifted kicad gets released, these manuals need to
> be updated and maybe reviewed. this might suggest that we could choose
> a different documentation format for kicad (web-based, online
> wiki-based, html documentation accessible via the kicad menu,
> restructured text, etc.).
> What are the options out there? What do you think we should do about
> it? Who would be interested in working on it?
> Just as term of comparison, here:
> http://inkscape.org/doc/index.php
> http://tavmjong.free.fr/INKSCAPE/MANUAL/html/index.php
> you can find the only (on-line) documentation available of probably
> one of the best open-source graphical tool.
> in case of inkscape, documentation is online and tutorials are in the
> inkscape native format.
> Regards
> Fabrizio
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp

Follow ups