- How to access:
- What kinds of things should be documented?
- Operations Handbook: Users + Administrators Guide/reference manual
- How you've configured things, how to do things
- Do this for yourself + other people
- You will not remember what/how you did six months from now
- Especially helpful for things you do once per year
- In case you leave unexpectedly or unexpectedly
- Out sick and someone needs to cover for you
- You leave your job and someone needs to figure out where everything is
- List of vendors, software we use, checklists
- Recommended Hardware List
- Events Planning Documentation
- Document Assets (e.g. email addresses, website domains, etc) along with their settings
- Add a list of materials/supplies, the URL to reorder them, where they're located in the office
- Meeting Notes
- Course Notes
- Other Examples
- Why use a wiki?
- Collaborative documentation tool
- Designed for multiple authors to submit content
- Tools to enhance collaboration
- "Spaces" concept
- How to start your own wiki
- Request Process - Email cre-it@mit.edu
- Templates / Style Setup
- Assign Ownership to CRE IT
- Don't care what you do with it, you can co-own, but having CRE IT own it makes things easier for everyone
- If you leave, we still have access to it
- If I leave, CRE still has access to it
- Easier to track
- Creating Pages
- Formatting
- Headings
- Colors
- Styles
- Clearing Formatting
- Lists
- Unordered Lists
- Ordered Lists
- Task Lists
- Increase/Decrease Indentation
- Justification
- Links
- External URLs
- Other Wiki Pages
- Tables
- Page Layout
- Undo/Redo
- Images
- Copy/Paste
- Resize.
- Borders/Effects
- Attachments
- Linking vs embedding
- Links are better for files that you update; attachments will have several versions floating around
- Tagging files vs hierarchical
- Advanced Page Content
- Wiki Markup
- Status Icon
- Gliffy Diagrams (Visio Flowcharts)
- Macros
- Automatic Menu Generation
- Children Macro
- Navigation Tree Macro
- Table of Contents
- Options for each of these
- Math (LaTeX \[ x^n + y^n = z^n \] )
- iFrame
- Excerpts
- Include Page
- Blocks
- Information Block
- Note Block
- Warning Block
- Code Block
- Panel Block
- Page Operations
- Duplication / Moving / Deleting
- You can copy from any space (if DUSP has a relevant page, you can duplicate it)
- Attribution/Acknowledgement
- Permissions
- Page Permissions
- Groups vs Individual Users -- Use groups whenever possible
- all of our groups start with acls-cre-
- Groups should be set up by CRE IT (you can manage membership if you want)
- Groups can be teams of people (e.g. Communications, Finance Team, Lab Members, Project Team, Students in a course, etc...)
- Groups can also be roles (students, faculty, staff, researchers)
- Easy to update every year - no need to update tons of articles, just the members of the team. This also updates the email lists, and anything else you have assigned to them.
- Security: Software is from 2013, there are almost certainly security vulnerabilities in it - don't put super confidential information in it
- A workaround is to put confidential information in SharePoint (or some other storage provider), set permissions there, and link to it from the Wiki
- Make sure you comply with MIT's guidelines on storing sensitive data
- Change history
- Revert to previous versions
- Labels
- Watching Articles
- E.g. DUSP & Arch articles
- Searching (Global search vs space search)
- Browse > Space Admin
- Permissions
- Groups vs Individual Users -- Use groups whenever possible
- Restriction Pages (Find orphaned pages)
- Templates
- What should NOT go into a wiki?
- Don't try to teach an entire system (e.g. a sysadmin should know Active Directory; teach them about your configuration + settings, not AD)
- You can provide links to training resources if you want
- Don't rewrite/explain an entire website in the wiki. Just give details on what's necessary if the subject you're explaining is not self-explanatory
- Misc Resources
- Other Concepts:
- Structured Data (Next Generation Wiki)
- Custom URLs
- Working with other departments
- docstrings / javadocs
{"serverDuration": 136, "requestCorrelationId": "5949131c193319cc"}