Ruby60DocPlan
Documentation Plan for NetBeans 6.0 Ruby Support
This document provides information about the tutorials, videos, and online help that are planned for the FCS releases of NB 6.0 Ruby support.
For the overall documentation plan for the Beta and FCS releases of NB 6.0 FCS, see the NB 6.0 Umbrella Doc Plan.
Other plans are listed in Category NBInfoDeliverables60.
Contents |
Introduction
This plan describes the documentation deliverables for Ruby Applications . The documentation objectives are to provide clear, concise, technically accurate, and easily accessible information about using NetBeans 6.0. If there are dependencies on other functional teams, such as Engineering, QA, Marketing and the component products documentation teams, those are also listed in this document.
Dependencies
- All features must be complete enough to accurately document.
- The UI must be stable for step-by-step documentation accuracy.
- The quality of documentation will benefit considerably from QE and technical feedback.
Documentation Deliverables
Tutorials and Screencasts
Getting Started
| Document | Media | Priority | Writer | SME | Eng Review | QE Review | Edit | Published |
|---|---|---|---|---|---|---|---|---|
| Installing and Configuring Ruby Support in the NetBeans IDE | Tutorial | High | Chris | Community | Done | Approved by Thomas 9/6 | Edited by PJ 10/12 | Y |
| Getting Started With Ruby and Rails | Tutorial | High | Chris | Community | Done | Edited by Julie | Y |
Editing
| Document | Media | Priority | Writer | SME | Eng Review | QE Review | Edit | Published |
|---|---|---|---|---|---|---|---|---|
| Ruby Hints and Quick Fixes | Screencast | High | Cindy | Tor | Approved by Tor 9/7 | na | na | Y |
| Using Ruby Code Completion | Screencast | High | Cindy | Tor | Approved by Tor 9/5 | na | na | Y |
| Using Live Code Templates | Screencast | High | Cindy | Tor | Approved by Tor | na | na | Y |
| Refactoring With Tor | Screencast | High | Cindy | Tor | ||||
| Ruby Editor vs. Textmate | Tutorial | Nice to Have | Community | |||||
Ruby on Rails
| Document | Media | Priority | Writer | SME | Eng Review | QE Review | Edit | Published |
|---|---|---|---|---|---|---|---|---|
| Creating a Ruby Web Log in 10 Minutes | Tutorial | High | Gail | Brian | Approved by Brian 9/5 | Approved by Tomas for M9 | Edited by Julie 10/24 | Y |
| Creating a Ruby Web Log in 10 Minutes | Screencast | High | Cindy | Tor | Approved by Tor 11/05/07 | na | na | Y |
| Putting Flickr on Rails | Tutorial | Medium | Gail | Brain | Approved by Brian 11/29 | Approved by Tomas for M9 | Y | |
| Building Relationships Between Ruby Models | Tutorial | High | Gail | Brian | Approved by Brian 9/5 | Approved by Tomas 9/2 | Edited by Julie 10/24 | Y |
| Using Ajax With NetBeans Ruby | Tutorial | High | Natalie | Brian | ||||
Integrating Java and Ruby
| Document | Media | Priority | Writer | SME | Eng Review | QE Review | Edit | Published |
|---|---|---|---|---|---|---|---|---|
| Integrating Java and Ruby | Screencast | High | Cindy | Tor | Approved by Tor 8/30 | na | na | Y |
| Integrating Java and Ruby | Tutorial (rewrite) | High | Tor | |||||
Testing and Debugging
| Document | Media | Priority | Writer | SME | Eng Review | QE Review | Edit | Published |
|---|---|---|---|---|---|---|---|---|
| Test-Driven Rails Development | Article | High | Beth | Tor | Approved by Tor 8/30 | Approved by Jiri 8/30 | Y | |
| Using Rspec Featuring Nick Sieger | Screencat | High | Cindy | Nick | ||||
| Testing the Ruby Weblog Project | Tutorial | High | Brian | |||||
| Writing Unit Tests | Screencast | High | Cindy | Tor | approved by Tor | na | na | Y |
| Using the Ruby Debugger | Screencast | High | Cindy | Roman | Approved | na | na | Y |
Deployment
| Document | Media | Priority | Writer | SME | Eng Review | QE Review | Edit | Published |
|---|---|---|---|---|---|---|---|---|
| JRuby and Glassfish | Tutorial | High | Chris | Arun | ||||
Other
| Document | Media | Priority | Writer | SME | Eng Review | QE Review | Edit | Published |
|---|---|---|---|---|---|---|---|---|
| jmaki and Ruby | Tutorial | Medium | Chris | |||||
Online Help
For NetBeans 6.0, the online help will be minimal.
| Document | Writer | Notes | SME | Eng Review | QE | QE Review |
|---|---|---|---|---|---|---|
| Online Help | Paul | Goes in the scripting/ruby/help/ module | Tor | |||
