ESD Documentation Organization Jobs

 

AFS

1.      Create standard list of “functional” folders, under afs/slac/grp/cd/soft/html/ ü

a.       ug ü

b.      pg ü

c.       req ü

d.      design ü

e.       hw ü

f.        admin ü

g.       how-to ü

h.       ioc ü

i.         db ü 

j.        papers ü

2.      Create the index page under each of these. ü

3.      Create standard functional list (as in 1) for each major projects.

a.       pepii

b.      aida

c.       nlcta

d.      cater

e.       cmdSrv@

f.        cmlog@

g.       err

h.       fbck

i.         linux

j.        mps

k.      nlcdev

l.         cvs

m.     rmx

n.       pmw@

o.      python@

p.      share

q.      tcl

r.        unix

s.       vxworks@

t.        wwwman

u.       xgrabsc

v.       app

w.     ChannelWatcher

So we won’t do this for existing subdirs

      epics

      e158

      chimera

      development

                     perl

                     stds

4.      Create an index page for each project.  If there exists a page which is not titled “index.html” which currently acts as the home page, copy this page to index.html. 

5.      Create index page for each functional directory in each of these projects.

6.      Move everything out of share/slaconly

remove share/slaconly (cmdSrv and images link will remain in share/)

7.      Projects currently in slaconly/ which are not entirely slaconly should be moved so that it follows the scheme in which there is a slaconly folder contained in each project folder (e.g. move slaconly/unix to unix/slaconly).

8.      Other people

            Move cmlog

9.      Meet with project owners to move documents to appropriate standard directories.  Or ask project owners to move documents to appropriate standard directories by a specified date and use Web editing tool (Microsoft FrontPage or Macromedia Dreamweaver) to check links.

10.  Create “non-detailed” home page. ü

            http://www.slac.stanford.edu/grp/cd/soft/home.html

This is the public home page of the Software engineering group. It will be mirrored to webmcc.slac.stanford.edu/swmirror/home.html 

11.  Create the detailed home page:

            http://www.slac.stanford.edu/grp/cd/soft/index.html

VMS

1.      Create index pages in each of the DOC$ directories on VMS.

www-group

1.      Create standard directories on www-group. ü        

2.      Delete http://www-group.slac.stanford.edu/cdsoft/home.html.  We will use http://www.slac.stanford.edu/grp/cd/soft/home.html as our public home page instead.

3.      Rename documents/How To to documents/how-to, documents/requirements to documents/req, documents/Design to documents/design.  Move these three renamed folders up one level to the cdsoft folder.

4.      Move documents/Archiver and documents/NLC Documents up one level to the cdsoft folder.

5.      Move remainder of documents in documents folder to appropriate functional directories after consulting with document owners.

6.      Add hyperlinks to documents in www-group from detailed home page on AFS.

7.      Add projects in www-group to detailed home page on AFS.

webmcc

1.      Create standard directories on webmcc. ü

2.      Create “mirror” subweb for AFS mirror files.

www-internal

1.      Move contents of “how-to” folder to webmcc/how-to.

2.      Ask Ruth McDunn to delete https://www-internal/cdsoft folder.

Fix standard template

1.      Table that implements the header has a bug, so it changes size on Reload. The post reload is the size it should be. ü

2.      Add links to top level functional index pages ug,pg,hw etc at the bottom of the standard template. ü

3.      The block of quicklinks at the top of the standard template, on the RHS, is not wide enough – the “Software Engineering” link always wraps onto two lines. ü

Write How-To Publish Guide (In Progress)

1.      Write summary of publication locations available to our Group.  State which should be used in which case.

a.       Use AFS if it corresponds to a Unix project already located in AFS.

b.      Use www-group if you would like your documentation on an IIS server (you prefer to use Microsoft Windows or Microsoft FrontPage to create and edit your document) and it should be viewable to the public

c.       Use webmcc if you would like your documentation on an IIS server (you prefer to use Microsoft Windows or Microsoft FrontPage to create and edit your document) and it should not be viewable to the public

2.      Write a “How to Publish” guide for each location from a PC.

a.       From PC to AFS, use Macromedia Contribute.  Update detailed home page.

b.      From PC to www-group, use WebDAV/Web Folders and Microsoft FrontPage or Microsoft Word.  Update detailed home page on AFS.

c.       From PC to webmcc, use WebDAV/Web Folders and Microsoft FrontPage or Microsoft Word.  Update detailed home page on AFS.

Documentation Authors Guide (In Progress)