Welcome! Log In Create A New Profile


Product Documentation Template?

Posted by jeffpark_ 
Product Documentation Template?
April 12, 2010 04:02PM
Is there a wiki template for product documentation? E..g I create X product and want to release the source and instructions on the Wiki, how would I go about doing so?

I looked at some of the templates, but they seem like they are more geared towards instructions only. I think the template probably would need something like product version, history, developers, links to CAD file etc. Also, is there any naming convention for products? If I create a BestExtruderEver, should the wiki page be


Re: Product Documentation Template?
April 12, 2010 05:35PM
Best_Extruder_Ever would be best. That way you can make a link and have it "look right" in the context of a sentence.
"yadda yadda yadda [[Best_Extruder_Ever]] yadda yadda"
in the mediawiki markup code becomes
yadda yadda yadda Best_Extruder_Ever yadda yadda
on the web page.

Extruder:BestExtruderEver doesn't scan in a sentance, and BestExtruderEver was how we made wiki links using the old twiki.

I had earlier been thinking about Extruder/BestExtruderEver but I'm not sure if it actually adds any useful structure. I think it just makes the URL longer and creates another user-education hurdle. smiling smiley

-Sebastien, RepRap.org library gnome.

Remember, you're all RepRap developers (once you've joined the super-secret developer mailing list), and the wiki, RepRap.org, [reprap.org] is for everyone and everything! grinning smiley
Re: Product Documentation Template?
April 13, 2010 11:35AM
Wikipedia also uses underscores, so that's probably the way to go.

Although in a sentence, you might want to go with [[Best_Extruder_Ever|Best Extruder Ever]], so that the link looks right.
Re: Product Documentation Template?
April 13, 2010 04:50PM
Thanks for the info. I found the instructions


Re: Product Documentation Template?
April 14, 2010 01:50AM
[[Best Extruder Ever]] is enough. It is converted into /wiki/Best_Extuder_Ever as a link.

* homeprototype free 3d design repository
* Blog
* Google+
Sorry, only registered users may post in this forum.

Click here to login