wiki:Trac Specs

Version 9 (modified by Hai, 3 weeks ago) (diff)

--

Introduction

In any company some form of workflow is needed, 3DN is no exception to that. In most companies this is done through 'management'; One individual 'managing' several others with the purpose to build an efficient and effective team. The difficulty with this traditional management is that in many cases it seems to give said 'managers' some sense of being the team's 'leader'. This in turn gives other team members often the feeling of being 'followers' and they act in the same way:

  • Start asking what to do
  • Blame others if they cannot proceed and ask management to resolve
  • Take little initiative to learn new things

At 3DN we want to be different. We would like the workflow to behave similar to the 'opensource' process; People who enjoy learning new things, take own initiatives and take their newly learned skills to a new level by practicing them on new work. We believe that fostering such a work climate stimulates people to become self-leaders who take initiatives by themselves with the best of the company's interest in mind.

Goals and Success Criteria

The goal of using Trac inside 3DN is not to create any management or control tool. It's purpose is to share with colleagues, even others outside 3DN, what work we do and what things we learn. Through sharing not just our work and our new skills not only do we enrich others with our expertise, we also enrich ourselves through being proud of our work and not hiding it.

Trac appears to be a perfect tool for this purpose. Many opensource projects actually use it and it's also written and distributed as an opensource project itself. Anybody can freely download Trac, set it up on their own server, increase the functionality through plugins made by others and even by writing custom plugins where needed yourself. Trac provides us with ways to make great looking documentation, create reminders for ourselves to get work done, build clear and concise views of the dependencies of one person's work on another person's work, link work to software changes etc. etc.

The more is shared in this Trac, the greater the success will be. Ticket updates, software commits, Wiki page edits, in other words, the more we see in the Trac timeline, the better it will start to work. This does not mean that people should spend all their time in a day on writing Trac tickets and updates obviously, so later on in this document we will try to give some more detailed analyses of the success criteria.

Hardware

Trac runs on 3DN's main server. Currently we run multiple servers in our main office in the Netherlands and one server in our office in Vietnam. Trac runs on low-end virtual server and has very low demands on that server. On top of that this server is also a shared server which also runs Wordpress on Apache.

Operating System

Trac runs on Debian Linux Stretch. At the time of writing this document, 'Stretch' or Debian 9 is the most current stable release of the Debian Linux distro.

System Software

Trac is a Python application. This means that Python needs to be installed before being able to run Trac. At 3DN we have chosen not to use the standalone 'tracd' however as we already had a running Apache server and it's easy to configure Apache to run a Python plugin.

  • Python
  • Apache2

Statistical Data

Statistical data on the use of Trac will be gathered from the server's logfiles.

Network

Will be maintained by 3DN company. Will be scalable. Will intergrate with other 3DN server hosting web content.

Navigation

  1. Navigation bars will appear at the top, sticky bar.
  2. Clicking the logo on subordinate pages will navigate back to the homepage.
  3. Forward and Back buttons will be complaint with selected web browser (IE, Mozilla Firefox, Google, etc... )
  4. Links will be available and legacy systems as appropriate.(?)
  5. The site will include "bread crumbs" on tier 1 and 2 pages. (Breadcrumbs trail is an additional navigation tag on the page used to optimize the visitor's engagement on the site. In essence, Breadcrumbs is a collection of hierarchical links that let users know which page they are on and from which they can navigate smoothly across different pages on the site.) a-- Location breadcrumbs. b-- Attribute breadcrumbs. c-- Path Breadcrumbs.
  6. The user will drill down a maximum of 3 screens from either the home page or a tier 3 page.
  7. Web pages will be able to load completely within 10 seconds on a 56k dial-up connection.(?)
  8. No scrolling will be needed on the homepage(?)
  9. The home pages will have a link to tier 3 pages.
  10. Resource Links will use web technologies to display associated tier 1 or 2 page links.
  11. Tier 1 pages will provide links to associated tier 2 pages.
  12. Tier 2 pages will retain same navigation features as their associated tier 1

page.

  1. Tier 3 pages will provide links to organizational specific pages(tier 4)
  2. Tier 4 departmental pages (excluding individual faculty and staff pages)may be linked from both tier 2 and 3 pages
  3. Tier 5 pages will be linked from tier 4 pages.
  4. Links to .pdf files, MS Office documents, external sites, and the resources will open in a new browser window.
  5. A footer will be displayed on the homepage and all tier 1 through 3 pages;

the footer will include:

  1. Copyright information.
  2. Form page to submit comments about the web site – routed to Web Services Manager.
  3. Link to 3DN contact information.
  4. Privacy policy.

Logo

The logo will appear at the top of each 3DN page. The logo will be in a format that allows smooth resizing. No other logo beyond officially or intergrated programs will appear on the website without approval from 3DN.

Theme

Each official 3DN page will display the company colors. Consistent font style for content. Consistent paragraph and numbering scheme.

+ suggestion: Virtue WordPress? theme. + plugins: ... + sketch: work on CorelDRAW X8 or Photoshop or use Bootstrap HTML.

Content

  1. Each page will display the 3DN logo.
  2. The masthead will contain links to non-academic resources. + Text only version + Employment + Contact information + Search Function + Home
  3. A common masthead will be used for tier 1 and 2 pages.
  4. The home page and tier 1 and 2 mastheads will have links to logical grouped pages for patron resources.
  5. The homepage will have links to tier 1 pages (content pages).
  6. The web site will contain a secured employee intranet.
  7. Tier 4 and 5 pages will be developed using the CMS or other approved location given content/designer needs.(?)
  8. If individuals choose to maintain content outside of the CMS, they must also provide access to that content through the CMS.
  9. If any content is housed at a location external to the official web site, a statement notifying users that they are leaving the official 3DN web site must be displayed.
  10. Web site will include a site map and/or index.
  11. Web site will be able to display a text only version of content.
  12. Web site will include a searchable employee/department directory.
  13. A search function will be included on all pages, with the exclusion of faculty and staff pages if desired.
  14. Pages in the CMS will be chosen from developed templates consistent with the web site design.

Approvals

Site Management

Definitions