Corporate Software Development Wiki? 79
gnujoshua asks: "My company would like to expand the use of its Wiki to include source code and API documentation. It would be nice to have auto-generated, syntax highlighted, and well documented source code, integrated nicely into the Wiki. Ideally, changes to source could be made right in the Wiki, barring permissions, and furthermore, it would be nice to see if it compiles against the library as well. What recommendations does Slashdot have for Wikis and scripts that could be used effectively to this end?"
Perl, of course! (Score:3, Funny)
Re:Perl, of course! (Score:2)
The syntax.... it haunts me....
Re:Perl, of course! (Score:1)
Re:Huh? (Score:2, Funny)
Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:2)
For behind-the-firewall-less-than-10-people, Sourcesafe for Windows or CVS is just fine and likely to be on any OS you're running anyway. I like SS because I do a lot of work in Windows on Microsoft tools, so it
Re:Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:2)
What more would you want?
Re:Reinventing the wheel? (Score:2)
Re:Sourcesafe is the least safe VCS I have used (Score:2)
Re:Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:3, Insightful)
All the options you listed are for engineers only. If only engineers are involved in your design and development process, that's fine. For us, wiki is a great way to document our software development so that it is accessible not just to software developers, but also to documentation developers and tech support. It's great for this purpose beca
Re:Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:2)
Re:Reinventing the wheel? (Score:2)
Version Control: It's not just for coders. (Score:2)
Just look at the history feature of Wikipedia. It's arguably one of the most important features of the encyclopedia.
If Microsoft Word used a version control repository, a vast majority of business tragedies would be ameliorated.
How's that for a bold statement.
Re:Reinventing the wheel? (Score:2, Informative)
Version control is not just for programmers. It is applicable for almost all computer work, for keeping history, creating an audit trail, enable people to work toge
Wiki has version control (Score:2)
Version control is not just for programmers.
Which is why MediaWiki, in use by countless people through the website en.wikipedia.org, supports version control for all articles.
"In-house" solution (Score:2)
Re:What a Terrible Idea! (Score:1)
Re:What a Terrible Idea! (Score:1)
Re:Open access? (Score:2)
nDoc works for me! (Score:2)
-Rick
TWiki already uses RCS (Score:3, Informative)
TWiki [twiki.org] uses RCS as its backend. Thus if you use CVS for version control (which is based on RCS), modifying the Perl-based TWiki to talk with your CVS repository should be feasible.
Re:TWiki already uses RCS (Score:3, Informative)
TWiki also includes some plug-ins that may be useful for the author of this article, such as the SyntaxHighlightingPlugin [twiki.org] (which uses enscript as a back-end).
I am not sure that I would use a wiki for viewing source code because there are better tools for that (from viewcvs to gforge). But if you really want to, then TWiki [twiki.org] is probably the one that has the most useful features for a corporate environment.
Re:TWiki already uses RCS (Score:1)
Hi, I work for Software Company X (Score:1)
Something to start with (Score:2)
Trac [edgewall.com]: "Trac is an enhanced wiki and issue tracking system for software development projects."
Re:Something to start with (Score:1)
We've been using Trac for at least half a year at the office and it's simply great.
You can browse projects from a Subversion repository, syntax-hightlighted and everything. Keep track of tickets/milestones. And of course, you have the wiki.
Our setup uses SVNManager [sourceforge.net] + Trac for everything related to source control/documentation.
Re:Something to start with (Score:1)
Also: cvsTrac, FitNesse, and WikiBase (Score:2, Informative)
Long before Trac for Subversion, there was CVSTrac [cvstrac.org] for CVS. It's a little more austere, but offers the same features: integrated wiki, CVS change tracker, CVS browser, and trouble tickets. CVSTrac now can be compiled to support Subversion.
FitNesse [fitnesse.org] combines a Wiki with an acceptance testing tool. Tables on Wiki pages hold test data and expected outputs; click the "test" button and FitNesse runs your application with the test data and checks the results against the expected values (similar to JUnit and
Re:Also: cvsTrac, FitNesse, and WikiBase (Score:1)
Google (Score:4, Informative)
-GameMaster
Re:Google (Score:1)
Re:Google (Score:1)
I don't know about you, but I can read these news articles in any number of other places on the web. I come to Slashdot to read what this community has to contribute to the topic. I use Google to find links to information about a product, but I'll still seek out opinions from people I trust.
Don't insist on being part of every discussion. (Score:1, Offtopic)
-
Cheney's company is building [nytimes.com] prisons [halliburton.com] for the U.S. government.
Re:Google (Score:1)
What's the point? (Score:1)
Re:What's the point? (Score:1)
My recommendation is to use subversion and write a script that copies the source files to the wiki whenever someone commits changes, if such a script doesn't already exist.
Better yet, modify the Wiki code (M
TWiki + CVS? (Score:1)
I agree with other posts that using twiki to directly edit source code doesn't sound like a good idea..
TWiki plugins can do this (Score:2)
And they just released [twiki.org] a nice shiny version 4.0.0 of TWiki [twiki.org], which I can't wait to try out.
Trac? (Score:1)
DokuWiki has those features already (Score:2)
Re:DokuWiki has those features already (Score:1)
The rest was in the heads of those who were then working there and it left when they did, leading to a lot of reverse-engineering. (Fun, fun fun)
Jerry
Confluence (and JIRA) (Score:2)
Preface: Yes, I know they're not open source. Guess what? I don't care! It's great software!
I highly reccomend Confluence [atlassian.com] as a Wiki for software development. Aside from being just about the perfect Wiki for any purpose, it's got great syntax highlighting and plugins for development. Not sure if it would let you edit directly from the web, but seriously, reconsider that requirement. I doubt anyone would actually use that anyway. It does have JUnit test reports built in too, so it's even better if you're
Re:Confluence (and JIRA) (Score:1)
Re:Confluence (and JIRA) (Score:1)
They have this as the first reason:
JIRA has features that you just will not find in any other issue tracker:
* Easily build and save highly-configurable filters (dynamic queries) across all issues in the system.
Umm... SugarCRM, Bugzilla, SalesForce, and Remedy have this (to varying degrees)
* Share filters with other users, or subscribe to them and get the results emailed to you periodically.
In
Re:Confluence (and JIRA) (Score:1)
But you forgot one of the most important (don't know if it's listed on the atlassian website):
Userfriendliness
Bugzilla: maybe in version 10, but right now it is a royal pain, to the point of people developing alternative UIs for it.
SugarCRM: somewhat, but like all these CRM tools it's really bloated.
The great power of JIRA is more in the details, because on paper, bugzilla is really as good. But put both in the hands of some real users and you
Experiences with Confluence (Score:2)
Some positive aspects
Confluence IS OpenSource ... not FreeSoftware (Score:1)
Sources are available to commercial licence only ... but it's available. Looks like OpenSource to me. Maybe they should not give non-commercial licenses ?
http://www.atlassian.com/software/confluence/Con fluenceSourceDownloads.jspa
AWx
Re:Confluence IS OpenSource ... not FreeSoftware (Score:1)
Umm, they specifically say it's not open source! [atlassian.com]
The only difference between open source and free software is the marketing philosophy, anyway. If something isn't free software, it's by definition not open source, either.
Re:Confluence IS OpenSource ... not FreeSoftware (Score:1)
I'll define OpenSource by 3 points:
For a company, the point in OpenSource is not its low price. The point is having a safe route: if the underlying company/community disappears or the software support is abandonned or the "must-have" feature is still lacking and not planned at all or early enough, the company can assume the dev/maintanability/evolution by itself.
So, from a company point of view (if
Use SVN + TRAC (Score:2)
IT's a wiki!
It's a source browser (with color highlighting)
It's a ticket tracking system (can import bugzilla, or be turned off)
It's a floor wax!
It's a dessert topping
(well, not the last two).
But it's pretty awesome, INSANELY easy to set up, and pretty slick/easy to use.
Too damn many of you are missing the point (Score:2)
He does not want to store all of his code in the wiki.
He wants to set it up so that when a programmer CREATES a wikipage on a function, he can include source code FOR A SAMPLE INVOCATION of the function and have that code be nicely formatted, syntax-highlighted and so on without the programmer having to to do it all by hand.
In other words:
wikis allow external links (Score:2)
(btw, editing your project's source code from a web form for anything but the most trivial projects is a dumb idea. this is why we have IDEs and version control systems)
trac (Score:1)
From the "What is Trac" page:
* An integrated system for managing software projects
* An enhanced wiki
* A flexible web-based issue tracker
* An interface to the Subversion revision control system
Seems like that would work well for your purposes. I'm not sure if it does syntax highlighting, but it wouldn't be too hard to add that functionality.
Re:trac (Score:2)
And yes, it does syntax highlighting, and I think its the neatest syntax highlight setup I've seen in a while. It is very well done.
ANother option, harder to setup, but likely more feature rich, would be Horde. Horde has a Wiki module, bug tracking (whups), SVN access (Chora), and more. That's generally been the setup I've used, but Trac is really mak
Bad idea (Score:1)
Wouldn't it be much better to have your wiki link to something like ViewVC [viewvc.org] so you can see what the current code looks like.
If this is because you're having trouble getting your developers to comment their code, it's not going to make it easier by commenting in Wiki.
Anyway I'm a firm believer in documenting the reaso
Use it for autogenerated documentation instead (Score:1)
I contracted at a company where we looked into doing what you have suggested in the context of a BI team. Basically, using a wiki to submit code changes is a candidate for the Too Hard basket.
Instead, what we did was write a bunch of services that interrogated our various source code repositories (database schema, stored procs, code, cube specifications etc) and generate a page for every object we were interested in with links to related objects.
Each page will contained autogenerated documentation (for
trac/svn/java- and phpDoc (Score:2)
What you want is Trac (Score:2)
Trac [edgewall.com] is a web-based software project management and bug/issue tracking system. It provides an interface to Subversion [tigris.org] and an integrated wiki. It uses Apache and mod_python, but it's really easy to install if you follow the instructions.
You can see examples of it in use at PylonsHQ [pylonshq.com] and the Django [djangoproject.com] site, both of which are styled nicely. You can see a default install at PyDelicious [python-hosting.com].
And no, it's not only Python sites that use it. Th