Creating Documentation

[Aaron Jensen]

Here's a brief outline on what I think needs to be documented. I'm
open to any more topics or anything. Currently I'm thinking we should
just use github sites or the github README. Thoughts?

Also, would love to move this to wave if you all have it...

* Getting started
- Downloading/Building/Installing MSpec (would love to make this
simpler)
- How stuff works
- Subject/It/Because of/Establish context/Cleanup after

* Test runners
- Command line
- Support for TeamCity/Xml/Html/Selenium
- R#
- TD.NET

* Guidelines
- When to use base classes

* Framework Features
- IAssemblyContext
- ICleanupAfterEveryContextInAssembly
- [SetupForEachSpecification]

[Jeffery Olson]

I have wave and am fine with moving there..

.. of the top of my head, I think the quickest way to simplify the
download/install story would be to ship binaries of milestone
releases.. github supports downloads.

As far as Guidelines.. maybe a best practices/style guide? But it'd be
easy to just turn that into a prescriptive guidance on how to do
context/spec testing, which may or may be what we want. I recall your
comments about people using intention-revealing names for their
Becauses, instead of just "of". Is a README the place to put that
guidance out, or should that Guidelines section just provide links to
posts on the topic? or both? Maybe a non-authoritative "this is how
the framers of MSpec intended it to be used" sort of thing? This could
also be hashed out by users in a wiki in a "recipe" sort of format...

As far as github sites goes: it's pretty cool. I use it for my blog,
but.. what would it offer that couldn't be covered in the README? even
if you look at the github site for Sinatra, you can see that it is
mostly re-displaying info already in the README..

Cheers

> --
>
> You received this message because you are subscribed to the Google Groups "machine_users" group.
> To post to this group, send email to machin...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/machine_users?hl=.
>
>
>

[Hadi Hariri]

For some reason my other message didn't seem to get thru.

> Also, would love to move this to wave if you all have it...
>

I've got Wave too, but just forget to check it.

> * Getting started
>   - Downloading/Building/Installing MSpec (would love to make this
> simpler)

I'd be willing to write some kind of installer to ease integration
with TDD, R#, etc. I know R# is just copying files, but still :). Kind
of like the installer xUnit offers.

What will be used for writing the docs?

[Hadi Hariri]

> * Getting started
>   - Downloading/Building/Installing MSpec (would love to make this
> simpler)

+1. We've been discussing this on Twitter today :). I think anything
to make MSpec more mainstream is great. I can help with anything here
to make it simplier, including providing installers similar to xUnit
for TDD, R#, etc-.


I've also got Wave, so fine by me too to move it there, although I
constantly forget to check.

[Yonah Wahrhaftig]

Seeing as I don't really have any experience with MSpec, I would be
happy to start gathering the posts in existence out there and
compiling a list of links with synapses.

I also have google wave and could move there.

[Aaron Jensen]

I've created a wave, Yonah, I'm missing your gmail/wave account the email address you mailed here isn't on wave it seems.

--

You received this message because you are subscribed to the Google Groups "machine_users" group.
To post to this group, send email to machin...@googlegroups.com.

To unsubscribe from this group, send email to machine_user...@googlegroups.com.

[Yonah Wahrhaftig]

Aaron, I sent you a ping from my google wave account. It is under yonahw.

No virus found in this incoming message.
Checked by AVG - www.avg.com
Version: 8.5.425 / Virus Database: 270.14.67/2506 - Release Date: 11/19/09 07:51:00

[Tom de Koning]

Did you add me as well? Can't see the wave yet

 

Tom