Product Framework
See the google doc for a pretty looking product framework document. . . https://goo.gl/2ENL61
Product Framework This is a filled out version of our Code for America product framework template for sponsorship document
- There is an unmet demand for maps that promote housing construction advocacy well. Production of maps used for advocating housing construction is currently done infrequently, inefficiently and with limited functionality because different organizations producing and using maps have to make them at great time and expense as an original map project.
- See our problem definition document for more info.
- San Francisco Housing Advocacy Coalition (SFHAC) is our primary organization-user who will be a first adopter to modify the map to suit their needs of the moment.
- SFHAC users are our primary first adopter end-users.
- See our personas document for more info.
-
Our product is a map based website and widget that is well designed for advocacy of housing construction.
-
It comes preloaded with housing construction advocacy related data.
-
It’s preconfigured to meet housing construction advocacy related needs.
-
It has methods for organizing and mobilizing housing construction advocacy.
-
It supports crowdsourcing information and delegating ownership of data management to partner organizations.
-
It can be shared and branched so this data and functionality need not be re-invented.
-
See our functional goals document for more info.
- SFHAC as an organization-user benefits from having maps that work for them instead of having to work for their maps.
- The public as an end-user benefits from more convenient options, social media integration, and more insightful information that they can use to achieve their goals.
- See our user story document for more info.
- Think of any pro-housing construction advocacy related project, task or activity that uses a map. We want to make it easier and more effective with our better map.
- See our mission statement document for more info
- Yes.
- There are several “bigger stories” depending on your perspective.
- We’d like to hear from you about what you feel makes a compelling “bigger story”. We invite you to fill out our online form where you can tell us about yourself and the “bigger story” that you want to hear. The only requirement is that your bigger story must support housing construction advocacy and you must include the use of a map in the story somewhere.
Written By TypeYourNameHere:
Yadda Yae Shabbi Shab,
write something here,
it’s up for grabs.
Steve Whetstone: Created initial document wrote the majority of the unsigned content.
Add_your_name_here: one sentence for each contribution so we know who to thank and credit.
What’s the problem you’re solving?
Who's your main use case/user?
What does your product do specifically? aka features
How does your product benefit the user?
What is your elevator pitch? 2-3 sentences
Random thoughts related to this document. . .
Credit for work on this document. . .
see the SFBrigade document titled “Officially Sponsored Projects ABOUT (draft)” for more info. This is one of the documents needed for getting officially sponsored and also a good idea for structuring our document folders or information architecture. We have a copy of the SFBrigade master we’ve marked up and edited for specefic to SF-in-progress matters.
https://docs.google.com/document/d/1zY5UQLeqklJLJYtEzWdADmFii2oFnh1rFflNUD63W9M/edit > Written with StackEdit.
Convert google docs to markdown formatting for github Written by: SteveWhetstone https://github.com/mangini/gdocs2md doesn’t work with newest version of google docs. or actually, google docs doesn’t show the button the totorial says to click. try this one. . . http://lifehacker.com/this-script-converts-google-documents-to-markdown-for-e-511746113
On-boarding + Public Website + Trello + Slack + Git + Google Group + Google Drive
Product Framework This is a branded version of the Code for America product framework template for sponsorship document.
Introduction. . .
What’s the problem you’re solving? There is an unmet demand for maps that promote housing construction advocacy well. Production of maps used for advocating housing construction is currently done infrequently, inefficiently and with limited functionality because different organizations producing and using maps have to make them at great time and expense as an original map project. See our problem definition document for more info.
Who's your main use case/user? San Francisco Housing Advocacy Coalition (SFHAC) is our primary organization-user who will be a first adopter to modify the map to suit their needs of the moment. SFHAC users are our primary first adopter end-users. See our personas document for more info.
What does your product do specifically? aka features Our product is a map based website and widget that is well designed for advocacy of housing construction. It comes preloaded with housing construction advocacy related data. It’s preconfigured to meet housing construction advocacy related needs. It has methods for organizing and mobilizing housing construction advocacy. It supports crowdsourcing information and delegating ownership of data management to partner organizations. It can be shared and branched so this data and functionality need not be re-invented. See our functional goals document for more info.
How does your product benefit the user? SFHAC as an organization-user benefits from having maps that work for them instead of having to work for their maps. The public as an end-user benefits from more convenient options, social media integration, and more insightful information that they can use to achieve their goals. See our user story document for more info.
What is your elevator pitch? 2-3 sentences Think of any pro-housing construction advocacy related project, task or activity that uses a map. We want to make it easier and more effective with our better map. See our mission statement document for more info
Is there a bigger “story”? Yes. There are several “bigger stories” depending on your perspective. We’d like to hear from you about what you feel makes a compelling “bigger story”. We invite you to fill out our online form where you can tell us about yourself and the “bigger story” that you want to hear. The only requirement is that your bigger story must support housing construction advocacy and you must include the use of a map in the story somewhere.
Random thoughts related to this document. . .
Written By TypeYourNameHere: Yadda Yae Shabbi Shab, write something here, it’s up for grabs.
Credit for work on this document. . .
Steve Whetstone: Created initial document wrote the majority of the unsigned content.
Addyourname_here: one sentence for each contribution so we know who to thank and credit.
Table of Contents. . . Product Framework Introduction. . . What’s the problem you’re solving? Who's your main use case/user? What does your product do specifically? aka features How does your product benefit the user? What is your elevator pitch? 2-3 sentences Is there a bigger “story”? Random thoughts related to this document. . . Credit for work on this document. . . Table of Contents. . . Related documents. . .
Related documents. . . see the SFBrigade document titled “Officially Sponsored Projects ABOUT (draft)” for more info. This is one of the documents needed for getting officially sponsored and also a good idea for structuring our document folders or information architecture. We have a copy of the SFBrigade master we’ve marked up and edited for specefic to SF-in-progress matters. https://docs.google.com/document/d/1zY5UQLeqklJLJYtEzWdADmFii2oFnh1rFflNUD63W9M/edit
need to format the above for Git and Markdown formatting. Here's a great free markdown editor. try it in the browser at https://stackedit.io/editor Welcome to StackEdit!
Hey! I'm your first Markdown document in StackEdit[^stackedit]. Don't delete me, I'm very helpful! I can be recovered anyway in the Utils tab of the Settings dialog.
StackEdit stores your documents in your browser, which means all your documents are automatically saved locally and are accessible offline!
Note:
- StackEdit is accessible offline after the application has been loaded for the first time.
- Your local documents are not shared between different browsers or computers.
- Clearing your browser's data may delete all your local documents! Make sure your documents are synchronized with Google Drive or Dropbox (check out the Synchronization section).
The document panel is accessible using the button in the navigation bar. You can create a new document by clicking New document in the document panel.
All your local documents are listed in the document panel. You can switch from one to another by clicking a document in the list or you can toggle documents using Ctrl+[ and Ctrl+].
You can rename the current document by clicking the document title in the navigation bar.
You can delete the current document by clicking Delete document in the document panel.
You can save the current document to a file by clicking Export to disk from the menu panel.
Tip: Check out the Publish a document section for a description of the different output formats.
StackEdit can be combined with Google Drive and Dropbox to have your documents saved in the Cloud. The synchronization mechanism takes care of uploading your modifications or downloading the latest version of your documents.
Note:
- Full access to Google Drive or Dropbox is required to be able to import any document in StackEdit. Permission restrictions can be configured in the settings.
- Imported documents are downloaded in your browser and are not transmitted to a server.
- If you experience problems saving your documents on Google Drive, check and optionally disable browser extensions, such as Disconnect.
You can open a document from Google Drive or the Dropbox by opening the Synchronize sub-menu and by clicking Open from.... Once opened, any modification in your document will be automatically synchronized with the file in your Google Drive / Dropbox account.
You can save any document by opening the Synchronize sub-menu and by clicking Save on.... Even if your document is already synchronized with Google Drive or Dropbox, you can export it to a another location. StackEdit can synchronize one document with multiple locations and accounts.
Once your document is linked to a Google Drive or a Dropbox file, StackEdit will periodically (every 3 minutes) synchronize it by downloading/uploading any modification. A merge will be performed if necessary and conflicts will be detected.
If you just have modified your document and you want to force the synchronization, click the button in the navigation bar.
Note: The button is disabled when you have no document to synchronize.
Since one document can be synchronized with multiple locations, you can list and manage synchronized locations by clicking Manage synchronization in the Synchronize sub-menu. This will let you remove synchronization locations that are associated to your document.
Note: If you delete the file from Google Drive or from Dropbox, the document will no longer be synchronized with that location.
Once you are happy with your document, you can publish it on different websites directly from StackEdit. As for now, StackEdit can publish on Blogger, Dropbox, Gist, GitHub, Google Drive, Tumblr, WordPress and on any SSH server.
You can publish your document by opening the Publish sub-menu and by choosing a website. In the dialog box, you can choose the publication format:
- Markdown, to publish the Markdown text on a website that can interpret it (GitHub for instance),
- HTML, to publish the document converted into HTML (on a blog for example),
- Template, to have a full control of the output.
Note: The default template is a simple webpage wrapping your document in HTML format. You can customize it in the Advanced tab of the Settings dialog.
After publishing, StackEdit will keep your document linked to that publication which makes it easy for you to update it. Once you have modified your document and you want to update your publication, click on the button in the navigation bar.
Note: The button is disabled when your document has not been published yet.
Since one document can be published on multiple locations, you can list and manage publish locations by clicking Manage publication in the menu panel. This will let you remove publication locations that are associated to your document.
Note: If the file has been removed from the website or the blog, the document will no longer be published on that location.
StackEdit supports Markdown Extra, which extends Markdown syntax with some nice features.
Tip: You can disable any Markdown Extra feature in the Extensions tab of the Settings dialog.
Note: You can find more information about Markdown syntax here and Markdown Extra extension here.
Markdown Extra has a special syntax for tables:
| Item | Value |
|---|---|
| Computer | $1600 |
| Phone | $12 |
| Pipe | $1 |
You can specify column alignment with one or two colons:
| Item | Value | Qty |
|---|---|---|
| Computer | $1600 | 5 |
| Phone | $12 | 12 |
| Pipe | $1 | 234 |
Markdown Extra has a special syntax for definition lists too:
Term 1 Term 2 : Definition A : Definition B
Term 3
: Definition C
: Definition D
> part of definition D
GitHub's fenced code blocks are also supported with Highlight.js syntax highlighting:
// Foo
var bar = 0;
Tip: To use Prettify instead of Highlight.js, just configure the Markdown Extra extension in the Settings dialog.
Note: You can find more information:
You can create footnotes like this[^footnote].
[^footnote]: Here is the text of the footnote.
SmartyPants converts ASCII punctuation characters into "smart" typographic punctuation HTML entities. For example:
| ASCII | HTML | |
|---|---|---|
| Single backticks | 'Isn't this fun?' |
'Isn't this fun?' |
| Quotes | "Isn't this fun?" |
"Isn't this fun?" |
| Dashes | -- is en-dash, --- is em-dash |
-- is en-dash, --- is em-dash |
You can insert a table of contents using the marker [TOC]:
[TOC]
You can render LaTeX mathematical expressions using MathJax, as on math.stackexchange.com:
The Gamma function satisfying
Tip: To make sure mathematical expressions are rendered properly on your website, include MathJax into your template:
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML"></script>
Note: You can find more information about LaTeX mathematical expressions here.
You can also render sequence diagrams like this:
Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!
And flow charts like this:
st=>start: Start
e=>end
op=>operation: My Operation
cond=>condition: Yes or No?
st->op->cond
cond(yes)->e
cond(no)->op
Note: You can find more information:
[^stackedit]: StackEdit is a full-featured, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites.