These  documents are necessary to properly plan and document a website, application or production project, and they are critical to successful development, launch and maintenance/updates.  Here are some examples of my work creating documentation, and my notes on what should be included in these documents.

 

 

Creative Brief

The Creative Brief is also called a site plan, depending on the project. This is the first document to be created, usually from the initial information obtained from the client or project director.

Your Creative Brief should include:

• The Site Purpose
  What is the point of this website? And how is it going to fulfill that purpose better than any other site on the Web?
• The Site Goals
  SMART goals can help you take a mediocre site and make it great. Once you know the goals of the site, you can plan around them.
• The Customers
  Who is going to read this website? Try to be as specific as you can regarding your target audience. Include details like: age, hobbies, income, job title(s), and so on. You might envision different people coming to different parts of your site – that’s fine. But know who the audience is that you want to attract. And if your site is already live, you should include data on the audience that you currently have.
• The Content
  What will be on the site? Will the content change regularly? Will you focus on selling products with product pages or focus on providing information through articles? Is your content going to be mostly text or images or multimedia? Do you have the content already created or do you still need to get it?
• The Design
  What colors will your site be? Remember that design aesthetic varies across different demographics. So if you’re planning a website for cutting edge designers, it will have a different look than one designed for stay-at-home dads (except maybe those stay-at-home dads that are also cutting edge designers…). The design includes things like graphic elements, colors, fonts, and typography. The more you plan ahead of time, the easier the design phase will be.
• The Timeline
  Once you have the rest of the pieces of the plan together, you should decide on a schedule. Don’t forget to include time for testing, revision, and user feedback.

Flowcharts

So far I have found that this is a good way to visualize the MVC design flow.

Use case diagram

Here is how to write an effective use case and user story.

 

What is UML use case diagram

 

 

Site Map

I’m not sure if this is the same as what I need. This Sitemap is a google search meta code for html pages.

Here is a little info about the site map, it really is just a simple diagram showing the pages and how they link together.

 

WireFrame

Sequence Diagrams

Component Diagrams

Deployment Diagram

Database Diagrams

Here is my post on the charts and information regarding video production and graphics sizes.

I need to add some captioning to some videos. Here is the beef, from the docs at the tube.

A caption file contains both the text and information about when each line of text should be displayed.

A transcript file, on the other hand, just contains the text of what was said in the video. If the video’s in English, Spanish, Japanese or Korean, YouTube can use speech processing algorithms to determine when the words in a transcript should be displayed

 

In order to download auto-captions for a video, you must be the video owner. If this is true:

An .sbv file is just a text file with timecode information. You can use it in a caption tool, or you can open it with a regular text editor.

• Sign into your account
• On the Captions and Subtitles pane, look for the track called English: Machine Transcription. Click the Download button next to that track.
• YouTube will then save a file called captions.sbv to your desktop.

To add captions or subtitles to one of your videos, you’ll need to have transcript or caption files with the captions/subtitles in them. A transcript file must be saved as a plain text file without any special characters like smartquotes or emdashes.

YouTube uses experimental speech recognition technology to provide automatic timing for your English transcript. Automatic timing creates a caption file that you can download. Short videos with good sound quality and clear spoken English synchronize best.

Here are some other things you can do to help get the best automatic timing results for your transcripts:

• Identify long pauses (3 seconds or longer) or music in the transcript with a double line break.
• Use double line breaks anytime you want to force a caption break.

Here are some common captioning practice that help readability:

• Descriptions inside square brackets like [music] or [laughter] can help people with hearing disabilities to understand what is happening in your video.
• You can also add tags like >> at the beginning of a new line to identify speakers or change of speaker.
• Once you have the files, log into your YouTube account to upload them and:
  1. Mouse over your username located in the upper right corner of every page.
  2. Click Video Manager. You will then be directed to a page showing your uploaded videos.
  3. Find the video to which you’d like to add captions/subtitles and click the down arrow located to the right of the Edit and Insight buttons. Select the Captions and Subtitles button from the drop down menu.
  4. Click the Add New Captions or Transcript button on the right hand side of the page. You will be prompted to Browse for a file to upload.
  5. Select a caption/subtitle or transcript file to upload. If you are uploading a transcript (no timecodes), select Transcript file, otherwise, select Caption file.
  6. Select the appropriate language. If you wish, you can also enter a track name.
  7. Click the Upload File button.