codeforboston / project-template

Template READMEs and Wiki pages for new and established projects.
MIT License
4 stars 3 forks source link

Add placeholder language for users and other stakeholders to wiki #5

Open carlseglem opened 9 years ago

carlseglem commented 9 years ago

In wiki/What's-this-all-about….md, I suggest adding some placeholder language for

users

For each of them

For each of them

mjrouser commented 9 years ago

You bring up a really good point @carlseglem! These are all key considerations for a successful project.

To my way of thinking, there are two lanes of documentation here. One is geared at getting people quickly up to speed and ready to jam on code. The other is geared towards the careful planning and pre-work that needs to take place before any lines of code are pushed.

There has been some discussion of creating a project template for Hackpad. This would work towards the latter of these lanes and, might, possibly have the benefit of opening the process to more people (ie, not github familiar people).

Thoughts? Would you be interested in fleshing out a Hackpad template starting with the points you bring up in these issues?

carlseglem commented 9 years ago

Yeah, @mjrouser, I can see how Hackpad would be a lower hurdle to get started, and would reduce clutter of projects on Github that don’t get to the point of coding.

When a Github project is created, though, I think it’ll be helpful to move the information from Hackpad to the newly-created Github project’s wiki (with a pointer from earlier Hackpad page/doc to the wiki page(s)). Also, keeping the master content in Github will make it easier to track changes and share the template with other CfA groups.

I think I can take a shot at creating a Hackpad template. I’ll want to talk with you and @WheresHJ tonight a little about both content and mechanics, too.

mjrouser commented 9 years ago

Hey @carlseglem, I think that's a great way to look at it. Definitely run that down with Harlan.