Documentation: Difference between revisions

From Noisebridge
Jump to navigation Jump to search
(Created page with "{|style="background-color:#000;color:#f00;font-weight:bold;border:5px solid #f00;text-align:center;margin:auto;font-size:3em;line-height:1em;font-family:monospace;" |- |Docume...")
 
(Minor formatting change. Should have used preview)
 
(45 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{|style="background-color:#000;color:#f00;font-weight:bold;border:5px solid #f00;text-align:center;margin:auto;font-size:3em;line-height:1em;font-family:monospace;"
{{wiki}}
|-
|Documentation Working Group
|-
|We don't know how Noisebridge works, but we'll write it down anyways
|}


{{headerbox}} '''Documentation Guild''' maintains the [[wiki]], [[signage]] and other NB info.
We don't know how Noisebridge works either, but we'll write it down anyways
* '''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.
* '''CHANNELS:''' #wiki on [[Slack]].
* '''MAINTAINERS:''' [[User:Lxpk|Lxpk]], [[User:Elan|Elan]]
* '''CURRENT PROJECTS:''' [[Wiki]] overhaul, [[NoiseFacts]] 2.0, [[NoiseManual]] print version, [[Zine]] ZIP4 Valentines Day 2022, [[Blog]] reboot
{{boxend}}
== Making Noisebridge Less Cryptic ==
'''Noisebridge is cryptic at times.''' Most of the time, actually.
'''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?
How does Noisebridge work? That is a damn fine question, but who really knows, eh?


= Projects =
The purpose of the Documentation Working Group is to '''encourage and maintain the documentation of Noisebridge'''.
 


* [[Manual]] - The Great Big Book of Noisebridge And How It Doesn't Fall Apart
= Things we do =
* [[:Category:Pages_maintained_by_the_Documentation_Working_Group]] - The important things that are usually kept up to date
* [[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]]
** [[MediaWiki:Sidebar|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.
** Ask for [[:Category:Photography Wanted|Photo Wanted]] pages.
== Special [[Wiki]] pages to find things to fix ==
* [[:Special:SpecialPages]]
* Browsing [[:Special:OrphanedPages]] and linking to them somewhere in the wiki


= Folks =
= Folks =
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: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.
* [[User:Tdfischer]]
* [[User:Tdfischer]]
* '''You!?'''
* [[User:Patrickod]]
* [[User:Frank]]
 
= Collaboration =
* We talk about reducing the [https://en.wikipedia.org/wiki/Bus_factor bus factor] of Noisebridge.
* #docs-wg on [[Slack]]
* Probably some sort of regular gathering of documentation hackers?
* Maybe even a monthly wiki sprint!
 
== 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.)
 
* [[Phone Bell]] - An upstairs door bell using an old Stromberg Carlson phone.
 
* [[Phone Booth ]]
 
=== Broken ===
Projects that need love to get working again.
* [[Kiosks]]
 
=== 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.
* [[Documentation Working Group Next Meeting]]
 
== Meeting Notes ==
 
We meet sometimes. Here are some meeting notes
 
* [[Documentation_Working_Group_09-25-14]]
 
== Taking care of our projects ==
Every wiki page that Docsbridge works on needs to be tagged with the following template:
 
<pre>
{{DocsWG}}
</pre>
 
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.
 
== History==
'''The first meeting of the Documentation WG was Thursday, September 18th, 2014 at 7 PM'''




{{DocsWG}}
{{DocsWG}}

Latest revision as of 15:04, 15 August 2023

Noisebridge | About | Visit | 272 | Manual | Contact | Guilds | Resources | Events | Projects | 5MoF | Meetings | Donate | (Edit)
Guilds | Meta | Code | Electronics | Fabrication | Games | Sewing | Music | AI | Neuro | Philosophy | Funding | Art | Security | Ham | Brew | (Edit)
MetaGuild | Recruiting Guilds | Volunteer | Documentation | Outreach | Working Groups | CommunityWorkingGroup | Badges | (Edit)
Documentation | Wiki | Signage | Labels | QR Codes | Note-taking | NoiseFacts | NoiseManual | (Edit)
Documentation Guild maintains the wiki, signage and other NB info.

We don't know how Noisebridge works either, but we'll write it down anyways

Making Noisebridge Less Cryptic[edit]

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.


Things we do[edit]

Special Wiki pages to find things to fix[edit]

Folks[edit]

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[edit]

The Wiki is a collaborative work of numerous Noisebridgers and these fine Documenters helped organize it.

Collaboration[edit]

  • We talk about reducing the bus factor of Noisebridge.
  • #docs-wg on Slack
  • Probably some sort of regular gathering of documentation hackers?
  • Maybe even a monthly wiki sprint!

Projects[edit]

  • 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[edit]

  • 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.)
  • Phone Bell - An upstairs door bell using an old Stromberg Carlson phone.

Broken[edit]

Projects that need love to get working again.

Unfinished[edit]

  • NoiseFacts is an idea for a small printed version of the manual for new arrivals.

Upcoming Meeting[edit]

We are going to have another meeting soon to discuss printing/lasercutting/constructing kiosks for Signage, wiki docs, etc.

Meeting Notes[edit]

We meet sometimes. Here are some meeting notes

Taking care of our projects[edit]

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.

History[edit]

The first meeting of the Documentation WG was Thursday, September 18th, 2014 at 7 PM


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
Retrieved from "https://www.noisebridge.net/index.php?title=Documentation&oldid=81545"