Part of this depends on your audience, so the kind of documents you would generate for, say, service engineers or other maintenance personnel would be different from documentation for users. Project documentation which is developed as you go along, for your own use, would be different again (although closer to the eventual documentation for engineers than for end users).
Marcus On 16 Apr 2013, at 10:49, propcoder wrote: > I do retrofitting or automate new machines. I do document them like most > of my projects, but how to do it better way? > > There are a lot of things to document, like: > project tasks, goals, requirements,.. > physical (axes, forces, motors, screws, belts, reducers, backlashes,..) > electronics (power, drivers, custom electronics with documentation and > all datasheets, cabling, signals, computer,..) > software (solutions used, tools needed) > G-code (codes to be used) > user manual... > todo list > known bugs, problems.. > > > ------------------------------------------------------------------------------ > Precog is a next-generation analytics platform capable of advanced > analytics on semi-structured data. The platform includes APIs for building > apps and a phenomenal toolset for data science. Developers can use > our toolset for easy data analysis & visualization. Get a free account! > http://www2.precog.com/precogplatform/slashdotnewsletter > _______________________________________________ > Emc-users mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/emc-users ------------------------------------------------------------------------------ Precog is a next-generation analytics platform capable of advanced analytics on semi-structured data. The platform includes APIs for building apps and a phenomenal toolset for data science. Developers can use our toolset for easy data analysis & visualization. Get a free account! http://www2.precog.com/precogplatform/slashdotnewsletter _______________________________________________ Emc-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/emc-users
