MDN: Web Animations documentation

RESOLVED FIXED

Status

RESOLVED FIXED
3 years ago
3 years ago

People

(Reporter: aspivak, Unassigned)

Tracking

Details

(Reporter)

Description

3 years ago
Initial Questions:

Project/Feature Name: MDN: Web Animations documentation
Tracking  ID:
Description:
Documentation on Web Animations for MDN, Hacks blog posts, content kit/presentation notes. 
Additional Information:
Statement of work
Rachel Nabors - Web Animations API documentation

This document outlines the scope of the work we are proposing for Rachel Nabors to undertake for Mozilla as part of a paid contract, including deadlines and costs. The work we would like her to undertake falls into three main areas:

A. Web Animations API reference documentation: In traditional MDN style, we want a full reference created for this API (as specified at http://w3c.github.io/web-animations/)
B. A hacks (https://hacks.mozilla.org/) post covering web animations, giving some basic examples, announcing the new MDN docs, and getting people excited about the area. We could maybe do 2 or 3 if we felt the need. We'll price these up per article.
C. A content kit to evangelise the Web Animations API - https://gist.github.com/callahad/1d0885dd70b157c3978e for an example content kit. The idea of the content kits is to provide all the information and resources needed to teach one or more short (say 1 hour to half a day) sessions that aim to teach/evangelise the topic in hand. We'd like to get web community members around the world to start adopting these kits when delivering their own presentations/sessions about tech topics.

Note: Rachel's hourly rate is $125.

-------------------------

A. Web Animations API reference docs

The canonical document for learning how to write an MDN API reference is here: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Write_an_API_reference. 

But generally the way to approach the work is to find an existing API reference and copy it (https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API is a good example)

Below is a listing of the pages we need for the Web Animations API reference docs:

1. Web Animation API basic concepts - 8 hours, $1000
I think we could do with a concepts document for this API, because it is pretty big, and there are quite a few concepts to explain.

2. Using the Web Animations API - 12 hours, $1500
This is your standard tutorial/guide that says "here is how you do all the basics and get up and running". It needs to show how to get started, explain some common tasks, and include some useful working code examples. Every API ref doc should have an associated "Using.." article.

3. Landing page - 4 hours, $600
The entry point into info about this API on MDN. Usually pretty short and sweet, and shouldn't take that much time.

4. Interface/property/method/constructor pages

Time for writing demos to demonstrate all this stuff: 16 hours - $2000

AnimationTimeline (interface landing page)
	currentTime
	play()
	getAnimations()
TIME: 8 hours - $1000
We will have a detailed review session after the first interface.

DocumentTimeline (interface landing page), inherited by animation timeline
	DocumentTimeline() (constructor)

Animation (interface)
	effect
	timeline
	startTime
	currentTime
	playbackRate
	playState
	ready
	finished
	cancel()
	finish()
	play()
	pause()
	reverse()
TIME: 13 hours - $1625 (less time per page than the previous one, but you should get a lot quicker once you've done a few of these)


AnimationEffectReadonly (interface)
	timing
	computedTiming
TIME: 2 hours - $250 

AnimationEffectTimingReadonly (interface)
	delay
	endDelay
	fill
	iterationStart
	iterations
	duration
	direction
	easing
TIME: 6 hours - $750

AnimationEffectTiming (interface)
	delay
	endDelay
	fill
	iterationStart
	iterations
	duration
	direction
	easing
TIME: 4 hours - $500 (less hours, as you can basically just copy and paste the previous pages)

KeyframeEffectReadonly (interface)
	KeyframeEffectReadonly() (constructor)
	target
	name
	iterationComposite
	composite
	spacing
	clone()
	getFrames()
TIME: 7 hours - $875

KeyframeEffect (interface)
	KeyframeEffect() (constructor)
	target
	name
	iterationComposite
	composite
	spacing
	setFrames()
TIME: 6 hours - $750

SharedKeyframeList (interface)
	SharedKeyframeList() (constructor)
TIME: 2 hours - $250	



Animatable (interface)
	animate()
	getAnimations()
TIME: 2 hours - $250



Extensions to other interfaces

Document.Timeline (add to Document reference)
Element.Animatable (add to Element reference)
TIME FOR THESE 2: 2 hours - $250

---------------------------------

B. HACKS POSTS
I'd estimate a hacks post as taking about 8 hours to write? So $1000 per post?

----------------------------------

C. WEB ANIMATIONS API CONTENT KIT
The exact contents of a content kit is still to be decided, but judging from the current ones we have so far, I'd estimate 16 hours for this.
$2000

TOTAL COST:

A. $11,750 for reference material (94 hours work)
B. $2000 for hacks posts (16 hours work)
C. $2000 for the content kit (16 hours work) 

TOTAL: $15,750 (126 hours work)
Key Initiative: Business Support
Release Date: 2015-11-30
Project Status: active
Mozilla Data: No
Mozilla Related: Platform
Separate Party: Yes
Type of Relationship: Vendor/Services
Data Access: No
Privacy Policy: 
Vendor Cost: > $25,000
(Reporter)

Comment 1

3 years ago
Bug 1159184 - Legal Review: Rachel Nabors - MDN: Web Animations documentation
Bug 1159185 - Finance Review: MDN: Web Animations documentation
(Reporter)

Updated

3 years ago
Depends on: 1159184, 1159185
Hi! It's been 2 weeks and nothing much seems to have moved on this. Rachel has been asking about the status of the contract. Is there I can tell her? She wants to get started asap, and has a good window to do this work coming up imminently.

thanks!
(In reply to Chris Mills (Mozilla, MDN editor) [:cmills] from comment #2)
> Hi! It's been 2 weeks and nothing much seems to have moved on this. Rachel
> has been asking about the status of the contract. Is there I can tell her?
> She wants to get started asap, and has a good window to do this work coming
> up imminently.
> 
> thanks!

Chris, you need to head to the legal bug 1159184 for the current status.
(Reporter)

Updated

3 years ago
Status: NEW → RESOLVED
Last Resolved: 3 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.