Documentation: Difference between revisions

From Noisebridge
Jump to navigation Jump to search
Lxpk (talk | contribs)
Add Nthmost to Folks
 
(22 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{wiki}}
{{wiki}}
{|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;"
{{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
|Documentation Working Group
* '''WHEN:''' Participates in refreshing wiki whenever and during [[meetings]] and [[Doocratic|Doocratic Thursday hack sessions 5-9PM]] via the [[Jitsi]].
|-
|We don't know how Noisebridge works, but we'll write it down anyways
|}
 
{{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]].
* '''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-and-docs-wg on [[Diacord]].
* '''MAINTAINERS:''' [[User:Lxpk|Lxpk]], [[User:Elan|Elan]], [[User:Justinmorrison|Justin]]
* '''CURRENT PROJECTS:''' [[Wiki]] overhaul, [[NoiseFacts]] 2.0, [[NoiseManual]] print version,
{{boxend}}
{{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.


Line 19: Line 16:
The purpose of the Documentation Working Group is to '''encourage and maintain the documentation of Noisebridge'''.
The purpose of the Documentation Working Group is to '''encourage and maintain the documentation of Noisebridge'''.


== History==
'''The first meeting of the Documentation WG is 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]]
* Enculturate others into producing Good Documentation
* [[Note-taking]] and tidying sometimes messed up notes formats
* Train hackers in the ways of Good Documentation
* [[Note-taking]]
* [[Signage]]
* [[Signage]]
* [[Transparency]]
* [[Transparency]]
* [[Ratchet]]
* [[Ratchet]]
* [[WorkingGroup:Documentation/Discussion]] - Whenever someone wants it
* [[WorkingGroup:Documentation/Discussion]] - Whenever someone wants it
 
* Teaching Noisebridgers
== Special pages to find things to fix ==
** 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]]
* [[: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 46: Line 47:
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)
* [[User:Mcint]] (Learned lots, on this wiki! templating, extensions, spam)
* [[User:Justinmorrison]] Cleanup, Copywriting, Usability, MediaWiki Maintenance
* [[User:Nthmost]] (making up for lost time in the scriptorium)
* '''You!?'''
=== 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]]
* [[User:Lxpk]]
* [[User:Frank]]
* [[User:Frank]]
* '''You!?'''
 


= Collaboration =
= Collaboration =
 
* We talk about reducing the [https://en.wikipedia.org/wiki/Bus_factor bus factor] of Noisebridge.
* #docs-wg on [[Slack]]
* #wiki-and-docs-wg on [[Discord]]
* Probably some sort of regular gathering of documentation hackers?
* Probably some sort of regular gathering of documentation hackers?
* Maybe even a monthly wiki sprint!
* Maybe even a monthly wiki sprint!
<div style="font-size:20px">We're the documentation working group! We meet during Philosophy talks bimonthly to talk about reducing the [https://en.wikipedia.org/wiki/Bus_factor bus factor] of Noisebridge.</div>


== Projects ==
== Projects ==
Line 67: Line 74:
=== In Progress ===
=== 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.)
* [[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 ]]
* [[Infra Meetup Projects]]


=== Broken ===
=== Broken ===
Projects that need love to get working again.
Projects that need love to get working again.
* [[Kiosks]]
* [[Kiosks]]
* [[Blog]]
* [[Website]]
* [[Signage]]


=== Unfinished ===
=== Unfinished ===
Line 76: Line 91:


=== Upcoming Meeting ===
=== 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]]
* [[Documentation Working Group Next Meeting]]


Line 93: Line 107:


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 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 04:22, 25 March 2026

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

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

Special Wiki pages to find things to fix

[edit | edit source]

Folks

[edit | edit source]

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)
  • User:Mcint (Learned lots, on this wiki! templating, extensions, spam)
  • User:Justinmorrison Cleanup, Copywriting, Usability, MediaWiki Maintenance
  • User:Nthmost (making up for lost time in the scriptorium)
  • You!?

Previous Active Documenters

[edit | edit source]

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


Collaboration

[edit | edit source]
  • We talk about reducing the bus factor of Noisebridge.
  • #wiki-and-docs-wg on Discord
  • Probably some sort of regular gathering of documentation hackers?
  • Maybe even a monthly wiki sprint!

Projects

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

Projects that need love to get working again.

Unfinished

[edit | edit source]
  • NoiseFacts is an idea for a small printed version of the manual for new arrivals.

Upcoming Meeting

[edit | edit source]

Meeting Notes

[edit | edit source]

We meet sometimes. Here are some meeting notes

Taking care of our projects

[edit | edit source]

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

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