Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Coding Standard Wiki

Tags:

c#

wiki-engine

At my place of work I've been put in charge of creating a coding standards document. Generally we follow what FxCop and StyleCop tools report to some degree but what we really require is document that will explain when to use a convention, why and maybe even a simple example.

This could be extended in the future for other purposes as well.

The first thing that came to my mind is to have an internal wiki site that we could build up and change easily over time but I've never used a wiki-based engine before and would like some recommendations.

If possible the engine should be in C# so we're able to tweak it to our needs if required.

If you think a wiki solution is the wrong way to go about this then please give an alternative :)


Update

I've just been informed, although we do have a php server it wont be staying, so I'm afraid php-based wiki ideas are off the table.


Update 2

Could you also (if possible) let me know if any of these solutions work with Active Directory?

Cheers Tony

like image 554
TWith2Sugars Avatar asked Jan 23 '09 13:01

TWith2Sugars


3 Answers

ScrewTurn Wiki is an free and open-source wiki made in C# and ASP.Net. Different database back-ends can be used, like MSSQL and MySQL, but also works without any database. It has several plugins to work with Active Directory.

like image 112
Lars Truijens Avatar answered Sep 17 '22 16:09

Lars Truijens


Mindtouch Deki

Great wiki and it's built on C# and PHP, so you can use it on Mono or .NET It also has Active Directory integration.

Download their ready-to-use VMware image. It started using it on my own PC then moved it to the company's VMware server when they had it ready.

like image 42
lamcro Avatar answered Sep 17 '22 16:09

lamcro


We keep an internal wiki at my shop that has almost all of our documentation (not just coding standards). We didn't really see the need to roll our own so we just used MediaWiki...

like image 25
Jason Punyon Avatar answered Sep 16 '22 16:09

Jason Punyon