Documentation: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 1: | Line 1: | ||
{{wiki}} | {{wiki}} | ||
{{Blackbox}} '''Documentation Working Group:''' We don't know how Noisebridge works, but we'll write it down anyways | {{Blackbox}} '''Documentation Working Group:''' We don't know how Noisebridge works either, but we'll write it down anyways | ||
{{boxend}} | {{boxend}} | ||
{{headerbox}} Documentation Guild maintains the [[wiki]], [[signage]] and other info about Noisebridge. | {{headerbox}} Documentation Guild maintains the [[wiki]], [[signage]] and other info about Noisebridge. | ||
* '''WHEN:''' Participates in refreshing wiki during [[meetings]] and [[Doocratic|Doocratic Thursday hack sessions 5-9PM]] via the [[Jitsi]]. | * '''WHEN:''' Participates in refreshing wiki whenever and during [[meetings]] and [[Doocratic|Doocratic Thursday hack sessions 5-9PM]] via the [[Jitsi]]. | ||
* '''HOW:''' Create an account on the Wiki and participate in channels to discuss. | * '''HOW:''' Create an account on the Wiki and participate in channels to discuss. | ||
* '''CHANNELS:''' #wiki on [[Slack]]. | * '''CHANNELS:''' #wiki on [[Slack]]. | ||
* '''MAINTAINERS:''' [[User:Lxpk|Lxpk]], [[User:Elan|Elan]] | |||
{{boxend}} | {{boxend}} | ||
| Line 16: | Line 17: | ||
== History== | == History== | ||
'''The first meeting of the Documentation WG | '''The first meeting of the Documentation WG was Thursday, September 18th, 2014 at 7 PM''' | ||
= Things we do = | = Things we do = | ||
* [[Wiki]] - working on improving the wiki | * [[Wiki]] - working on improving the wiki. Look here for details on using and improving our Wiki tags, templates, categories, naming conventions, CSS, etc. | ||
* [[Manual]] - The Great Big Book of Noisebridge And How It Doesn't Fall Apart | ** [[Manual]] - The Great Big Book of Noisebridge And How It Doesn't Fall Apart | ||
* [[Phong]] | ** [[Phong]] | ||
* [[MediaWiki:Sidebar|Sidebar menu]] | ** [[MediaWiki:Sidebar|Sidebar menu]] | ||
* [[:Category:Pages_maintained_by_the_Documentation_Working_Group]] - The important things that are usually kept up to date | ** [[:Category:Pages_maintained_by_the_Documentation_Working_Group]] - The important things that are usually kept up to date | ||
*Non-Wiki Activities | |||
* Collect mail from the [[Mailbox]] | * Collect mail from the [[Mailbox]] | ||
* Scan [[Documents]] | * Scan [[Documents]] | ||
* [[Note-taking]] and tidying sometimes messed up notes formats | |||
* [[Note-taking]] | |||
* [[Signage]] | * [[Signage]] | ||
* [[Transparency]] | * [[Transparency]] | ||
* [[Ratchet]] | * [[Ratchet]] | ||
* [[WorkingGroup:Documentation/Discussion]] - Whenever someone wants it | * [[WorkingGroup:Documentation/Discussion]] - Whenever someone wants it | ||
* Teaching Noisebridgers | |||
** Enculturate others into producing Good Documentation | |||
** Train hackers in the ways of Good Documentation | |||
* [[MetaGuild]] assistance to other [[Guilds]] | |||
** [[Recruiting]] more active Documenters to preserve maintenance continuity and resiliency | |||
** Asking de-facto event organizers and resource maintainers if they consent to being listed on the Wiki as such | |||
** Mentioning at meetings what guilds are [[recruiting]] more maintainers to help everything reach 2-5 maintainers. | |||
== Special pages to find things to fix == | == Special [[Wiki]] pages to find things to fix == | ||
* [[:Special:SpecialPages]] | * [[:Special:SpecialPages]] | ||
* Browsing [[:Special:OrphanedPages]] and linking to them somewhere in the wiki | * Browsing [[:Special:OrphanedPages]] and linking to them somewhere in the wiki | ||
| Line 41: | Line 48: | ||
Collaboration by all interested parties present and future is key here; '''not''' power-seeking control!<br> | Collaboration by all interested parties present and future is key here; '''not''' power-seeking control!<br> | ||
We the underhacked have pledged to contribute to the never-ending task of scribbling down things about Noisebridge: | We the underhacked have pledged to contribute to the never-ending task of scribbling down things about Noisebridge: | ||
* [[User:Lxpk]] (Made the nav menu templates and tries to help guilds | * [[User:Lxpk]] (Made the nav menu templates and tries to help guilds | ||
| Line 47: | Line 53: | ||
* '''You!?''' | * '''You!?''' | ||
=== Previous Active | === Previous Active Documenters === | ||
The Wiki is a collaborative work of numerous Noisebridgers and these fine Documenters helped organize it. | |||
* [[User:Tdfischer]] | * [[User:Tdfischer]] | ||
* [[User:Patrickod]] | * [[User:Patrickod]] | ||
Revision as of 18:29, 19 December 2021
| Noisebridge | About | Visit | 272 | Manual | Contact | Guilds | Stuff | Events | Projects | Meetings | Donate | E |
| Guilds (Volunteer) | Maintainers | Meta | Code | Electronics | Fabrication | Games | Sewing | Music | AI | Neuro | Philosophy | Funding | Art | Security | Ham | WGs | E |
| MetaGuild | Recruiting Guilds | Volunteer | Documentation | Outreach | Working Groups | CommunityWG | Badges | E |
| Documentation | Wiki | Signage | LED Signage | Posters | Labels | QR Codes | Note-taking | NoiseFacts | NoiseManual | Nb.wtf | V · T · E |
| Documentation Working Group: We don't know how Noisebridge works either, but we'll write it down anyways |
Documentation Guild maintains the wiki, signage and other info about Noisebridge. |
Noisebridge is cryptic at times. Most of the time, actually.
How does Noisebridge work? That is a damn fine question, but who really knows, eh?
The purpose of the Documentation Working Group is to encourage and maintain the documentation of Noisebridge.
History
The first meeting of the Documentation WG was Thursday, September 18th, 2014 at 7 PM
Things we do
- Wiki - working on improving the wiki. Look here for details on using and improving our Wiki tags, templates, categories, naming conventions, CSS, etc.
- Manual - The Great Big Book of Noisebridge And How It Doesn't Fall Apart
- Phong
- Sidebar menu
- Category:Pages_maintained_by_the_Documentation_Working_Group - The important things that are usually kept up to date
- Non-Wiki Activities
- Collect mail from the Mailbox
- Scan Documents
- Note-taking and tidying sometimes messed up notes formats
- Signage
- Transparency
- Ratchet
- WorkingGroup:Documentation/Discussion - Whenever someone wants it
- Teaching Noisebridgers
- Enculturate others into producing Good Documentation
- Train hackers in the ways of Good Documentation
- MetaGuild assistance to other Guilds
- Recruiting more active Documenters to preserve maintenance continuity and resiliency
- Asking de-facto event organizers and resource maintainers if they consent to being listed on the Wiki as such
- Mentioning at meetings what guilds are recruiting more maintainers to help everything reach 2-5 maintainers.
Special Wiki pages to find things to fix
- Special:SpecialPages
- Browsing Special:OrphanedPages and linking to them somewhere in the wiki
Folks
Collaboration by all interested parties present and future is key here; not power-seeking control!
We the underhacked have pledged to contribute to the never-ending task of scribbling down things about Noisebridge:
- User:Lxpk (Made the nav menu templates and tries to help guilds
- User:Elan (Knows a LOT about advanced MediaWiki tech)
- You!?
Previous Active Documenters
The Wiki is a collaborative work of numerous Noisebridgers and these fine Documenters helped organize it.
Collaboration
- #docs-wg on Slack
- Probably some sort of regular gathering of documentation hackers?
- Maybe even a monthly wiki sprint!
We're the documentation working group! We meet during Philosophy talks bimonthly to talk about reducing the bus factor of Noisebridge.
Projects
- Signage is ongoing. Make/Suggest signs that should exist or changes to improve them.
- Labels need to go directly on everything, whereas the sign may go next to it with more info.
- Promotion group creates updated bulletins about things happening at the space and promotes them to the outside world.
In Progress
- Hackstations (Kiosk enclosures for major tools/activity areas with attendant pegboard for attaching relevant bookshelves/supplies relevant and Signage elevated above it to make it easy to find with instructions for use.)
Broken
Projects that need love to get working again.
Unfinished
- NoiseFacts is an idea for a small printed version of the manual for new arrivals.
Upcoming Meeting
We are going to have another meeting soon to discuss printing/lasercutting/constructing kiosks for Signage, wiki docs, etc.
Meeting Notes
We meet sometimes. Here are some meeting notes
Taking care of our projects
Every wiki page that Docsbridge works on needs to be tagged with the following template:
{{DocsWG}}
This will ensure that it has the following notice at the bottom and that we can keep tabs on these pages and keep them in good working order.
|
This page is maintained by the Documentation Working Group. If technical writing is your thing, you should consider helping out by editing this page! | Document ALL The Things! YES, ALL THE THINGS | Edit |