From 0c94479bb1a8abd0dfd2038c5e8c1248c013ad34 Mon Sep 17 00:00:00 2001 From: "Bradley M. Kuhn" Date: Thu, 14 Nov 2013 12:36:04 -0500 Subject: [PATCH] Update EvaluationTemplate to have clearer links to each UseCase The idea is to use the evaluation template to fill out for each project codebase evaluation we do, but have an easy link back to the use case it refers to. As I was making this edit, I added a few FIXMEs to things that need clarification and/or completion. --- ExistingProjects/EvaluationTemplate.mdwn | 19 ++++++++++++------- UseCases/Collaborating.mdwn | 3 ++- UseCases/GeneratingReports.mdwn | 12 ++++++------ UseCases/WorkFlow.mdwn | 1 + 4 files changed, 21 insertions(+), 14 deletions(-) diff --git a/ExistingProjects/EvaluationTemplate.mdwn b/ExistingProjects/EvaluationTemplate.mdwn index 37d6266..4c069e5 100644 --- a/ExistingProjects/EvaluationTemplate.mdwn +++ b/ExistingProjects/EvaluationTemplate.mdwn @@ -1,10 +1,15 @@ - -## [[UseCases/GeneratingReports]] evaluation - -- Does it support Fund Reports? - +## Evaluation of GeneratingReports UseCases +- [[Trial Balance Report|GeneratingReports#trial-balance]]: FIXME +- [[Bank Reconciliation Report|GeneratingReports#bank-reconcilation]]: FIXME +- [[Chart of Accounts|GeneratingReports#chart-of-accounts]]: FIXME +- [[Cash Disbursements Journal|GeneratingReports#cash-disbursements]]: FIXME +- [[Income Report|GeneratingReports#income-report]]: FIXME +- [[Expense Report|GeneratingReports#expense-report]]: FIXME +- ## [[UseCases/Collaborating]] evaluation +- [[Simultaneous Editing of Ledger|Collaborating#simultaneous-ledger-edits]]: FIXME +- FIXME: Other uses cases need rewrite. -- Does it support multiple users working on the same ledger? -- ... +## Evaluation of WorkFlow UseCases +- [[Unaccrued Invoice?|UseCases/WorkFlow#unaccrued-invioice]]: FIXME diff --git a/UseCases/Collaborating.mdwn b/UseCases/Collaborating.mdwn index c702a55..1092dfb 100644 --- a/UseCases/Collaborating.mdwn +++ b/UseCases/Collaborating.mdwn @@ -1,7 +1,8 @@ As an accountant that collaborates with other accountants I need: + - Simultaneous editing of the same ledger -- In the case of decentralized ledgers, such as ledger-cli files shared via DVCS +- FIXME: this should probably be stated differently: In the case of decentralized ledgers, such as ledger-cli files shared via DVCS - Easy synchronization of entries from separate ledgers in order to efficiently and collaboratively perform accounting tasks. diff --git a/UseCases/GeneratingReports.mdwn b/UseCases/GeneratingReports.mdwn index b6c23ef..27ac344 100644 --- a/UseCases/GeneratingReports.mdwn +++ b/UseCases/GeneratingReports.mdwn @@ -5,13 +5,13 @@ As an US-based NPO I need a way to *generate reports* in order to: The usual reports an NPO is expected to generate, and all of these should be generatable for any given date period: -- [Trial balance](http://en.wikipedia.org/wiki/Trial_balance) -- [Bank Reconciliation Report](http://en.wikipedia.org/wiki/Bank_reconciliation) +- [Trial balance](http://en.wikipedia.org/wiki/Trial_balance) +- [Bank Reconciliation Report](http://en.wikipedia.org/wiki/Bank_reconciliation) + This report often needs to be generated with input from the user, since [the subset sum problem](http://en.wikipedia.org/wiki/Subset_sum_problem) is [NP-complete](http://en.wikipedia.org/wiki/NP-complete), human intervention is often needed to identify the specific transactions to show on this report. -- [Chart of accounts](http://en.wikipedia.org/wiki/Chart_of_accounts) -- Cash Disbursments Journal -- Income Report (just a list/sum of all Income accounts for a period) -- Expenses Report (just a list/sum of all Expenses accounts for a period) +- [Chart of accounts](http://en.wikipedia.org/wiki/Chart_of_accounts) +- Cash Disbursements Journal +- Income Report (just a list/sum of all Income accounts for a period) +- Expenses Report (just a list/sum of all Expenses accounts for a period) - [[Fund Report|UseCases/FundAccounting#FundReport]] Also, To handle [[UseCases/FundAccounting]] all of these reports should be generatable narrowed to specific funds. diff --git a/UseCases/WorkFlow.mdwn b/UseCases/WorkFlow.mdwn index c519446..3ce6b5a 100644 --- a/UseCases/WorkFlow.mdwn +++ b/UseCases/WorkFlow.mdwn @@ -6,6 +6,7 @@ bookkeeper who might make an error easily if the system doesn't require a workflow), the workflow should not be dictated. ## The "Unaccrued Invoice" Example + The easiest example I have of this relates to accruing income upon invoice generation. Non-profits very typically generate invoices as part of a