Child pages
  • sakai doc meeting 2012-01-12

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

  • Elizabeth Venstra (Indiana KB)
  • Mathieu Plourde (University of Delaware)
  • Matt Clare (Brock University)
  • Becca Darling (Wellesley College)
  • Neal Caidin (Duke University)
  • Alan Regan (Pepperdine University)
    Agenda:
  • Review tools - Walk through of Master List & Sample content page
  • Notes vs Comments
  • Present Quickstart Expectations & Terminology Guidelines - enough to get new people started?
  • Sign-Up 
  • Bi-weekly meetings are intended to help keep people on track - what is the best use of these meetings? We want to make sure they’re meaningful, powerful & useful
  • Progress reports? Touch base? Challenges? Need help? Larger topics Rich Text Editor vs WYSIWG?
  • Next steps - propose producers set milestones/deadlines for their pages & communicate them in the Google doc
  • Questions?
    Resources:https://docs.google.com/document/d/11cY4gjgTb_xixdYwHpXi36jhWWgw0iwUtB__vmGk8M8/edit
    Source for the Sakai 2.9 Test Instance & Help Fileshttps://qa29.longsight.com/ 
     Use the New Account tool to create an account for yourself. 
     
     New style suggestions:https://confluence.sakaiproject.org/display/ESUP/Help+Files+2.9+Styleguide+Notes 
    Notes:
    How do you track the changes which happened in Google docs? - File > Revision History - Presents it linearly.  ... New content in Red? Comment on deleted content, so there's a record of it existing?
    If this gets to be too much work, we can just deal with finding the differences on our own
    Strikethrough is good!
    No, it would not be difficult on our end to deal with strikethrough.
    Either way is probably fine.
    If we know where to look in the doc, we can take it from there.
    So not necessary to make it 100% marked up.
    --- 
    Conventions:
  • New text added in red. * Important * 
  • Removed text, apply strikethrough formatting
  • You can add yourself to the share, so your changes aren't anonymous
  • Use comments first, copy them to notes section at the bottom of the document if you need to resolve the comments or clear space.
  •  
    Styleguide quick notes additions
    "Kill all unnecessary prepositions" - Add to the Styleguide quick notes
    Capitalize the first word and then any proper noun in the title (Name of tool is generally capitalized)
    Link text in the left nav would need to be changed by someone outside this group. No guarantee anyone who can do the work would have time.
  • Wiki Markup    FYI: in the case of new  
     
    FYI: in the case of new documents--in some cases, there might be existing content in the IU domains that is not yet in the Sakai help.
    Not sure if this is the same feature or not: [https://kb.iu.edu/data/avpa.html|https://kb.iu.edu/data/avpa.html]   
    (as the new reorder announcements feature)
    So--not the same.
    Brock University may also have some, we'll add where we can. WYSIWYG editor  - accuracy is primary characteristic - is the documentation accurate for CK editor and FCK editor \--  Elizabeth says global change for WYSIWYG to Rich Text Editor request is in the queue \:)  \--I will check at some point, and then can easily implement on my end. \* There is one document that refers to FCK editor by name; will need to pay attention to. If there are differences in screenshots between FCK/CK, we'll definitely want to get new screenshots . . . IU will still be using FCK till at least next December/January, for reference. *Timeline*: we think mid-March-ish to have content reviewed Software release scheduled for April 12. Chicago Manual of Style is our back-up guide too. We use only "click", never "click on", and I'm going to be very resistant to changing that. However--we can get that on our end.  Don't worry too much about style . . . Sam O at Longsight is working on a way to get changes directly into trunk skipping the Cape Town process (and bypassing the IU repository, I assume) ... we need to make sure we have our docs & ducks in a row.   Re which docs are being pulled right now: Jonathan and I are trying to figure that out, but lots of things keep distracting our attention from that.  \:( \-Elizabeth Once the files are listed in trunk, what happens afterwards? Drupal-based?   -\- All for a new process, but as we approach it, Drupal isn't the most colaborative tool *Future Meeting Topics*: CK/FCK editors Talk about Longsight-built central tool for community management of documentation \[after march\] Future - Future conversation - expanding help formats to other media, such as video \---Alan, we'll check in with a to-do list for follow-up from the call? Yes. Action
    WYSIWYG editor  - accuracy is primary characteristic - is the documentation accurate for CK editor and FCK editor -- 
    Elizabeth says global change for WYSIWYG to Rich Text Editor request is in the queue :) 
    --I will check at some point, and then can easily implement on my end.
    * There is one document that refers to FCK editor by name; will need to pay attention to.
    If there are differences in screenshots between FCK/CK, we'll definitely want to get new screenshots . . .
    IU will still be using FCK till at least next December/January, for reference.
    Timeline: we think mid-March-ish to have content reviewed
    Software release scheduled for April 12.
    Chicago Manual of Style is our back-up guide too.
    We use only "click", never "click on", and I'm going to be very resistant to changing that.
    However--we can get that on our end.  Don't worry too much about style . . .
    Sam O at Longsight is working on a way to get changes directly into trunk skipping the Cape Town process (and bypassing the IU repository, I assume) ... we need to make sure we have our docs & ducks in a row.  
    Re which docs are being pulled right now: Jonathan and I are trying to figure that out, but lots of things keep distracting our attention from that.  :( -Elizabeth
    Once the files are listed in trunk, what happens afterwards? Drupal-based? 
     -- All for a new process, but as we approach it, Drupal isn't the most colaborative tool
    Future Meeting Topics:
    CK/FCK editors
    Talk about Longsight-built central tool for community management of documentation
    [after march] Future - Future conversation - expanding help formats to other media, such as video
    ---Alan, we'll check in with a to-do list for follow-up from the call?
    Yes.
    Action Items:
  • DONE--Alan: update style guide to reflect note about page titles (capitalization and proper nouns)
  • Becca: calling all writers -- notice to get more participation to review tools and sign up (one producer per tool, several collaborators to help with writing, editing, etc.)
  • I can issue a general call and reminder.  Sweet.  Thanks!
  • Becca: Update workflow conventions for editing (Comments vs notes) red & strikethroughs
  • All teams: begin work.  As Mathieu said, we're now in production. The sooner we get started, the better.  As we run into questions, post them to the documentation listserv.
  • IN PROGRESS--Alan: Follow up with Sam from Longsight on Drupal tool to update the help files directly
  • Elizabeth: try to determine which docs are being pulled for the Sakai help files system
  • Alan: research Elizabeth's questions about what happens long-term for sustainability of doc files for Sakai Help.  Also, help IU determine how they will use IU KB moving forward for Sakai files?
    Wow. I think that's almost it. 
    I think so, too.  Yeah!
    Hooray! :) 
    Thx, Becca.  Enjoy some lunch!
    Thanks :) that's the plan :) talk to you soon
    Cool.  Be good.

...