Great comments! I'd just like to touch lightly on the last point you mentioned which is TestFu. You're right, there's a complete absence of documentation on it. TestFu never really matured to the point where it would really be useful for most test writers. Consequently it will not be ported to MbUnit v3. New first-class features will be added instead to make up the difference. And you can bet those new features will have solid documentation behind them.
So I don't recommend using the TestFu classes in any new work at this time. It's too bad as there are some good ideas in there. We'll see what we can do about preserving those ideas as we move forward. Jeff. -----Original Message----- From: [email protected] [mailto:[EMAIL PROTECTED] On Behalf Of Wesley Hunt Sent: Friday, February 01, 2008 4:05 PM To: MbUnit.User Subject: MbUnit Re: wiki, where did it go? First, let me thank you for the work that has been done. Having the Sandcastle reference docs have their own benefits, and I'm glad they are there. Feedback sucks because it tends to focus on the negatives, and there are a lot of things to like about what has been done with the docs! Moving to Sandcastle and a more professional presentation is definitely an improvement! Docs can't be udpated as fast as a wiki, but of course wikis have their own set of problems... :) As for the non-API reference docs: * The Getting Started section is great! ** Writing your first tests was nice introduction to TDD with MbUnit, which is good to have. ** The overview of the related categorization attributes (author, category, etc) and assert/warning ignore were great. *** That's what I'd like more of. More high-level talk of features and how to use them. ** The GUI and Cons runner references are also well-written, and my occasional references to them seemed to cover the scenarios I was looking for, like: *** running the GUI automatically *** console args that have no effect *** how to debug tests *** managing projects vs. individual assemblies ** However, it might be nice to have devoted sections for all of these topics (there are for some), because people will scan the heading first to narrow down their search. ** For instance, details on managing projects vs. assemblies and using a debugging is stuck in the middle of the workflow example in #4. They need an easier-to-find section. * The importance of the snippets IMO is not stressed enough. It's a very good form of usage documentation in the absence of such in the current docs. Basically, it's the closest thing we have to what used to be in the old wiki. Heck, just throw the old wiki examples in the snippets folder until you have time to put them in the Sandcastle docs! * The MbUnit custom build tasks doesn't seem to work so well right now (see other threads in this group). Might want to mention the threads of issues if it won't get fixed. * I found the rest of the pages spot-on and very relevant! * "What do you want to test today?" ** My "offline" CHM version is blank! ** Looking at the online version, it has the same problem as the API reference, IMO. ** It focuses on code-oriented, not feature-oriented organization. ** I don't want to see "class attributes", "method attributes", etc. ** I'd rather see Fixtures, Decorators, Setup/TearDown, etc. ** More than anything, I'd like the Fixtures to list all decorators, etc that are relevant to them. See how the old wiki organized "Fixtures". ** A section listing all Decorators is only really useful if each page provides context as to what fixtures they relate to. Globally useful attributes (Ignore, Explicit, etc) could be categorized as such. Again, this is where the current docs really fall short. * Do test configuration files still work? There's no word in the current docs that I see, but the wiki had a whole page on it. * The wiki pages on "Useful tools" needs to come back. I found ConsoleTester quite useful, and was fairly confused as to what ManualTester's purpose was originally. * The TestDecoratorOverview from the wiki needs to come back. It was very useful to understanding how things work. * Speaking of overviews, something in the non-API docs should talk about: ** how MbUnit does it's work. Just getting the 10,000 ft overview of what MbUnit is doing under the hood helps orient you to the fact that you will spend most of your time familiarizing yourself with: *** groups of related attributes *** specialized assert routines that check for conditions you care about. ** creating your own tests. This is hard to find anywhere on the net. * TestFu needs SOME sort of documentation BADLY. Some kind of high- level purpose for some of the classes. Am I just missing it on the web somewhere? I finally resorted to crawling around in the source to figure out what some of the stuff does. I don't know if that falls under the purview of the MbUnit team? HTH, Wes On Feb 1, 4:33 pm, hmobius <[EMAIL PROTECTED]> wrote: > Got to apologize for this as it's my tardiness which means this page > -http://docs.mbunit.com/help/html/WhatDoYouWantToTest.htm- isn't doing > what it should be, although it's similar in structure to the wiki front page. > > The API reference aside though (which is being worked on) , what do > you think of the rest of the documentation we have put up on > docs.mbunit.com? > > Dan > > On Feb 1, 1:28 am, Wesley Hunt <[EMAIL PROTECTED]> wrote: > > > > > Unforunately, I don't have specific questions because I don't know > > what many of the classes do. Since many rely on a disconnected set > > of unrelated attributes, it is often unclear which ones work > > together and how. The code samples at the very least gave me a clue > > as to what attributes worked together. > > > Frankly, I miss the clear layout that used to be the front page of > > the mertner wiki docs: > > http://web.archive.org/web/20070609052712/http://www.mertner.com/conf... > > The namepace-centric organization of the Sandcastle docs I find > > overwhelming, as it mixes up classes and attributes and internal > > stuff with more commonly used stuff. The wiki front page was a great > > one- stop shop for the classes most commonly used. > > > Also, the wiki actually explained the high-level purpose of the > > attributes and how they related, not just what a single method does > > in isolation (as the Sandcastle docs), which doesn't really help. > > Almost all the method descriptions are empty anyway, so you are left > > with no way to figure out how to use a class. > > > For instance, I was trying to remember just now what > > TestSuiteAttribute was used for--the name is too generic for me to > > remember. The current docs are totally useless (they are quite > > literally blank), but the mertner wiki showed me how to use it > > instantly with a very clear explanation and detailed code example: > > >http://web.archive.org/web/20070625130708/www.mertner.com/confluence/... > > > It shows what it is, what fixture it is used by, and how methods > > that are decorated with it should be structured. > > > Without this info, novice users are really left in the dark. > > > -Wes > > > On Jan 31, 1:52 pm, Jeff Brown <[EMAIL PROTECTED]> wrote: > > > > The Mertner wiki also contained a bunch of information that was incorrect > > > or misleading. But I take your point regardless. > > > > I will pass these comments along to the team. > > > > Is there anything I can help you with now? > > > > Jeff. > > > > -----Original Message----- > > > From: [email protected] > > > [mailto:[EMAIL PROTECTED] On Behalf Of Hungry for > > > Knowledge > > > Sent: Thursday, January 31, 2008 3:30 AM > > > To: MbUnit.User > > > Subject: MbUnit Re: wiki, where did it go? > > > > Unfortunately the code samples are no longer included. > > > > I've been setting up MbUNit in december and used the mertner wiki > > > extensively for code samples, like for the AssemblyCleanupAttribute > > > attribute, which was very clearly explained. I can not find this back in > > > the current documentation. > > > > I really think it's a shame the mertner wiki got canceled because it > > > provided a lot of extra information on use cases for the various > > > attributes. The current documentation is simply a summary of what classes > > > exist but provides no help on use cases. > > > > Serge Desmedt > > > > My Blog:http://sdesmedt.wordpress.com > > > > On 17 jan, 02:45, "Jeff Brown" <[EMAIL PROTECTED]> wrote: > > > > Sorry, my answer might not have been very clear. > > > > > The content from the Mertner wiki has been migrated for the most > > > > part into the new docs site. The wiki itself has been retired. > > > > > Jeff. > > > > > -----Original Message----- > > > > From: [email protected] > > > > [mailto:[EMAIL PROTECTED] > > > > On > > > > > Behalf Of Jeff Brown > > > > Sent: Wednesday, January 16, 2008 3:42 PM > > > > To: [email protected] > > > > Subject: MbUnit Re: wiki, where did it go? > > > > >http://www.mbunit.com/http://docs.mbunit.com/ > > > > > Jeff. > > > > > -----Original Message----- > > > > From: [email protected] > > > > [mailto:[EMAIL PROTECTED] > > > > On Behalf Of Wesley Hunt > > > > Sent: Wednesday, January 16, 2008 3:34 PM > > > > To: MbUnit.User > > > > Subject: MbUnit wiki, where did it go? > > > > >http://www.mertner.com/confluence/display/MbUnit/Documentation > > > > > Everything is dead now, and a quick look around the web gives no > > > > clue as to what happened. can someone shed some light as to where it > > > > went? > > > > > Thanks, > > > > Wes- Tekst uit oorspronkelijk bericht niet weergeven - > > > > > - Tekst uit oorspronkelijk bericht weergeven -- Hide quoted text > > > > - > > > > - Show quoted text -- Hide quoted text - > > > - Show quoted text -- Hide quoted text - > > - Show quoted text - --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "MbUnit.User" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/MbUnitUser?hl=en -~----------~----~----~----~------~----~------~--~---
