Skip to content

Instantly share code, notes, and snippets.

@liam-middlebrook

liam-middlebrook/template.md

Last active August 29, 2015 14:20
Show Gist options
  • Save liam-middlebrook/fb48d3f07104ac3ab189 to your computer and use it in GitHub Desktop.
Save liam-middlebrook/fb48d3f07104ac3ab189 to your computer and use it in GitHub Desktop.
Download ZIP
GitBook Template Profile
Raw
template.md

Profile: %Subject%

Authors

  • Name <handle/email>

Rationale

There are so many subjects you could choose to profile, so why did you choose this one? What drew you into wanting to know more about the organization? How did you/your group decide on and agree?

Organizational Details

  • Is the subject of your profile a corporate entity?
  • What type?
  • When was it founded?
  • By whom?
  • Original founder(s) still active?
  • Publicly Traded? Since when? Initial Stock Price? Current stock price?
  • Has the company made any acquisitions? If yes, which companies, and what were their core products?
  • Has the company made any investments in other companies? If yes, which ones.
  • Number of Employees?
  • Where is HQ?
  • Does it have any other offices or locations?
  • Website?
  • Wikipedia?
  • Does your organization file any annual reports? Please include links to any relevant documents (i.e. 990, Annual Report, Year in Review, etc...)

Communications

Social media for COMPANY

  • Does your subject participate in social media?
  • If yes, please list a URL for each account, and reach within that community.
  • Example: - Twitter: @RedHatNews - 61.9K Followers.

Communications channels for COMPANY

  • What communication channels does your subject use to reach their public?
  • Briefly describe and include a URL for each.

COMPANY Conference Participation

  • Does your subject organize or participate in any conferences?
  • If so, list them here, and provide links to any relevant sessions, keynotes, or content.

Community Architecture

Your subject likely runs or contributes to one or more Open Source products or projects. Choose one (or more) of these and answer the following questions:

  • If applicable, list and provide links to: - The project's IRC Channel - Source Code repository - Mail list archive - Documentation - Other communication channels - Project Website and/or Blog

  • Describe the software project, its purpose and goals.

  • Give brief history of the project. When was the Initial Commit? The latest commit?

  • Who approves patches? How many people?

  • Who has commit access, or has had patches accepted? How many total?

  • Has there been any turnover in the Core Team? (i.e. has the top 20% of contributors stayed the same over time? If not, how has it changed?)

  • Does the project have a BDFL, or Lead Developer? (BDFL == Benevolent Dictator for Life)

  • Are the front and back end developers the same people? What is the proportion of each?

  • What have been some of the major bugs/problems/issues that have arisen during development? Who is responsible for quality control and bug repair?

  • How is the project's participation trending and why?

  • In your opinion, does the project pass "The Raptor Test?" (i.e. Would the project survive if the BDFL, or most active contributor were eaten by a Velociraptor?) Why or why not?

  • In your opinion, would the project survive if the core team, or most active 20% of contributors, were hit by a bus? Why or why not?

  • Does the project have an official "on-boarding" process in place? (new contributor guides, quickstarts, communication leads who focus specifically on newbies, etc...)

  • Does the project have Documentation available? Is it extensive? Does it include code examples?

  • If you were going to contribute to this project, but ran into trouble or hit blockers, who would you contact, and how?

  • Based on these answers, how would you describe the decision making structure/process of this group? Is it hierarchical, consensus building, ruled by a small group, barely contained chaos, or ruled by a single or pair of individuals?

  • Is this the kind of structure you would enjoy working in? Why, or why not?

Technology/Product

Section adapted from EFF Worksheet

  • Who invented, created, or sponsored the technology?
  • What is the technology designed to do? How is it used?
  • Who would benefit from using this technology?
  • What kinds of companies or organizations (stakeholders) might have been concerned about the development of this technology? Why?
  • Does/Did an aspect of copyright law play a role in controversies about the technology? How?

Business and Revenue Model

  • How was this organization funded originally?
  • How does this organization make revenue?
  • Which specific Open Source Revenue Models are utilized?
  • What investments/acquisitions has the organization made?
@decause
Copy link

decause commented Apr 30, 2015

This is a good start. Let's port this to the etherpad, and then commit to the bizlegfoss repo under the assignments folder as final-profile-template.md

@decause
Copy link

decause commented Apr 30, 2015

s/Company/Subject/g

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment