Click here to Skip to main content
15,881,559 members
Articles / All Topics

Integration of MediaWiki for (but not only for) technical documentation

Rate me:
Please Sign up or sign in to vote.
0.00/5 (No votes)
31 Oct 2011CPOL1 min read 4.8K  
MediaWiki, to centralize all our documents into a single repository easily reachable by all the team.
After being intronized Manager of Research & Development about two years ago, one of my first projects was to set up a set of technical documentation (in Microsoft Word format) to define rules to be followed by the .NET (and VBA) development team.

A documentation for C# rules, one other for ASP.NET applications, yet another for the rules database objects...

Now, although it is more and more complete, it is also more and more heavy and cumbersome, and finally less and less read (so followed) by the team, despite the code reviews and regular reminders.

Following a discussion with my brother (who is a talented developer much closer to open-source world than me), we talked about MediaWiki, which made me want to try to use it in order to centralize all our documents into a single repository easily reachable by all the team.

Article after article, link after link, we get quickly to the game. After only two weeks, much of our documentation is already migrated, a lot of new articles have quickly emerged, and this new tool is now interesting for everyone: the development team (and managers) can now quickly find the information they need to work properly, rules are now better followed.

As for the collaborative aspect, we currently limited editing to management, but we plan to allow each developer to contribute to the documentation with the establishment of moderation.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Chief Technology Officer Stambia
France France
I'm a 39 year old team deputy CTO, living and working near Lyon (France)

I started to write softwares in the end of 90's, when I was a teenager.

I acquired several but complementary skills, mainly (but not only) on Microsoft's technologies and platforms : assembly (x86, 68k), C, C++, .NET/C#, JavaScript/HTML/CSS, PHP, DBMS (MySQL, Oracle, SQL Server, etc.), etc.

During 2007-2012, I was particulary active on .NET, ASP.NET, C#, SQL Server and ORM (NHibernate) with a growing time spent on architecture, technical management, code review, etc.

Since 2013, I'm a full-time development team leader/manager at Everial, I stopped development at work but still love to develop some personnal programs during my spare time, mainly for domotic purposes. I use to play with Arduino, ESP8266/NodeCmu, Raspberry PI... running them with some C++ and .NET Core.

My hobbies are futsal, badminton, motorcycle, Formula One, domotic, gardening... and software developement.

Comments and Discussions

 
-- There are no messages in this forum --