odca-jekyll icon indicating copy to clipboard operation
odca-jekyll copied to clipboard

Share calculation methodologies in FAQ

Open elinaru opened this issue 6 years ago • 6 comments

See: https://www.opendisclosure.io/faq/#odca-calculation-methodologies

Currently this FAQ section reads, "The code we use to make these calculations can be found in the caciviclab/disclosure-backend-static repository (https://github.com/caciviclab/disclosure-backend-static/tree/master/calculators)."

This isn't really accessible to non-developers. Can we be more explicit how we calculate our totals here?

elinaru avatar Aug 15 '18 03:08 elinaru

Since the existence of this project I've wanted to create a campaign finance wiki as it's own project to document how all of this stuff works in California. It's all pretty complicated to put in an FAQ, but maybe we want to link to a wiki. This is something I'd like to take on since we're still learning things about how it all works. How does that sound?

adborden avatar Aug 22 '18 02:08 adborden

That was kind of a temporary home for the campaign finance wiki, but I'm looking at turning it into a proper website.

adborden avatar Aug 22 '18 02:08 adborden

Works for me.

elinaru avatar Aug 29 '18 03:08 elinaru

Looks like a good start. I'll read through it.

sfdoran avatar Aug 29 '18 16:08 sfdoran

@sfdoran, @anlawyer and I talked about this and have begun to devise a plan.

@tdooner is going to show @anlawyer and me around the backend on Tues 1/28. We will start a notes Google Doc at that time to start to document how the various calculations work. That document can serve as the starting point for resolving this issue.

We see this issue as high priority for quality control, our own accountability, and onboarding of future backend developers.

A diagram would also be helpful in helping people understand out how we do the calculations.

ckingbailey avatar Jan 27 '20 02:01 ckingbailey

See helpful reference in @adborden's 9-item list on issue #305

ckingbailey avatar Jan 27 '20 02:01 ckingbailey