Skip to content

Commit

Permalink
improve docs organization (make multi-page)
Browse files Browse the repository at this point in the history
  • Loading branch information
countvajhula committed Sep 20, 2023
1 parent ec233f8 commit 87b896b
Show file tree
Hide file tree
Showing 4 changed files with 145 additions and 134 deletions.
136 changes: 3 additions & 133 deletions dia-docs/DIA.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -2,137 +2,7 @@

@title{DIA Process}

@section{For project contributors}
@table-of-contents[]

@subsection{List contributions}

@itemlist[
#:style 'ordered

@item{Analyze the project and write down all @emph{labor} contributions and who made them. This is just everything you can think of that anyone ever did in the vicinity of the project. Write these down as "X did Y" where X is the name of the person and Y is what they did. The descriptions should be minimally self-contained so as to convey the relevance of the contribution to an informed layperson.}

@item{Share this list with other contributors and community members to solicit input until there is broad agreement that it is comprehensive.}

@item{Commit this list into the project repository at abe/labor.md. Record a unique identifier (such as a commit hash) for the last contribution on the main line of development that is accounted for in the file, i.e. that the list is "current up to." The chosen contribution need not be the most recent one made, but all contributions preceding the chosen one must be accounted for and there should be no gaps of unaccounted contributions.}

@item{Create another file abe/labor-anonymized.md containing the same line items but restated in passive voice without contributor names (e.g. "Y was done" instead of "X did Y").}

@item{Repeat steps 1-4 for all @emph{capital} contributions (e.g. source code, libraries and APIs used) and their sources. The descriptions should be minimally self-contained, as before. Commit this list as abe/capital.md and abe/capital-anonymized.md.}

@item{Repeat steps 1-4 for all @emph{ideas} exhibited by the project. The descriptions should be minimally self-contained, as before. As you will likely think of these ideas in a "top down" fashion, i.e. high level ideas followed by more specific ideas, it would be most helpful to write down this tree representation of these ideas as you see them reflected in your project. Commit this as abe/ideas.md.}
]

@subsection{Cost analysis and proxy analysis}

@itemlist[
#:style 'ordered

@item{Come up with an estimate of all costs incurred in creating the project. This could include estimates for the cost of labor using suitable hourly wages and number of person hours. Commit this "cost analysis" as abe/cost-analysis.md}

@item{Identify other projects that are similar or analogous to the project and gather information about their pricing and valuation. Commit this "proxy analysis" as abe/proxy-analysis.md}
]

@section{For congress participants}

@subsection{Attribution}

@subsubsection[#:style 'unnumbered]{1 Analyze}

@itemlist[
#:style 'ordered

@item{On your own, analyze the project's anonymized labor contributions and organize them into a tree that you feel is representative, where the leaf nodes are the actual elements of the original list, and higher-level nodes represent groupings of the lower-level nodes.}

@item{Repeat for the project's anonymized capital contributions.}

@item{Repeat for the project's anonymized idea contributions.}

@item{Share your analysis with the other attendees.}

]

@subsubsection[#:style 'unnumbered]{2 Agree on Analysis}

@itemlist[
#:style 'ordered

@item{As a group, discuss to reconcile the different labor analyses to agree on one labor tree that decomposes the project's labor contributions in a way that accounts for all of the independent analyses.}

@item{Repeat step 1 for the capital analysis.}

@item{Repeat step 1 for the ideas analysis.}

]

@subsubsection[#:style 'unnumbered]{3 Identify Antecedents}

@itemlist[
#:style 'ordered

@item{As a group, annotate each @emph{leaf} idea in the agreed-upon ideas tree with any projects that you can think of, that is, projects exhibiting that idea or a similar idea. These projects need not have any other relationship to the present project besides common ideas, and these should be recorded with no consideration to temporality (i.e. whether the project came before or after the present one). Projects may appear on any number of leaf ideas.}

@item{Identify projects in the annotated ideas tree that were announced within a year (on either side) of the present project, and write those down as a list of identified "cognates," retaining them on the annotated ideas tree. These will be treated in the same way as true antecedents.}

@item{Identify projects in the annotated ideas tree that were announced more than a year after the present project, and write those down as a list of identified "subsequents," removing them from the annotated ideas tree.}

]

@subsubsection[#:style 'unnumbered]{4 Appraise}

@itemlist[
#:style 'ordered

@item{On your own, starting at the highest node in the labor analysis, appraise the proportion of value contributed by each labor component, progressively working your way into deeper levels of the tree. How important is each component compared to the others? The total of all of the components at each level must equal 100%.}

@item{Repeat (1) for the capital analysis.}

@item{Repeat (1) for the ideas analysis.}

@item{Share your appraisals with the group.}

]

@subsubsection[#:style 'unnumbered]{5 Agree on Appraisals}

@itemlist[
#:style 'ordered

@item{Discuss to reconcile the different labor appraisals to agree on one appraisal that apportions value in the project in a way that accounts for all of the independent appraisals.}

@item{Repeat (1) for the project's capital appraisal.}

@item{Repeat (1) for the project's ideas appraisal, distributing the value of each "leaf" idea in the tree evenly over its antecedents.}

]

@subsubsection[#:style 'unnumbered]{6 Reconcile the Appraisals}

Discuss to assign weights to each appraisal tree. Consider using the 1-N-N² rule -- that is, if labor is worth K, then capital is worth 1/N × K, and ideas are worth 1/N² × K, for some "scaling factor" N that you agree on. The rationale is that we want labor, capital and ideas to be equally valuable when aggregated over all projects. Since labor is the least portable while ideas are the most portable, this rule models the fluidity of these categories as, roughly, "for every project you directly work on, N projects will use your work, and N² projects will be inspired by it." Note, nevertheless, that the ideas analysis described elsewhere in this document is not in terms of "inspiration" (implying causation) but only similarity.

@subsubsection[#:style 'unnumbered]{7 Deanonymize and Tally}

@itemlist[
#:style 'ordered

@item{"Deanonymize" – connect each leaf node in the appraised labor tree to a single contributor in the original non-anonymous list prepared by core project contributors.}

@item{Repeat (1) for capital.}

@item{Sum up the proportions by leaf nodes across all appraisal trees, weighted by the scaling factor for each tree (i.e. in the manner decided upon in "reconcile the appraisals"), to arrive at the final attributive proportions that total to 100%. Deliver this as an abe/ATTRIBUTIONS.txt file in the project repository.}

@item{Deliver the list of cognates and subsequents as abe/cognates.txt and abe/subsequents.txt, respectively, to be committed to the project repository.}

]

@subsection{Pricing and Valuation}

@itemlist[
#:style 'ordered

@item{Review the cost analysis and proxy analysis provided by the project.}

@item{Come up with a fair market price for use of the project.}

@item{Come up with a valuation of everything created so far in the project.}

]
@include-section["for-project.scrbl"]
@include-section["for-congress.scrbl"]
2 changes: 1 addition & 1 deletion dia-docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ remove:
raco pkg remove $(PACKAGE-NAME)

build:
scribble --html --dest output --dest-name index.html DIA.scrbl
scribble --htmls --dest-name output DIA.scrbl

view: build
open output/index.html
Expand Down
108 changes: 108 additions & 0 deletions dia-docs/for-congress.scrbl
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
#lang scribble/manual

@title{For congress participants}

@table-of-contents[]

@section{Attribution}

@subsection[#:style 'unnumbered]{1 Analyze}

@itemlist[
#:style 'ordered

@item{On your own, analyze the project's anonymized labor contributions and organize them into a tree that you feel is representative, where the leaf nodes are the actual elements of the original list, and higher-level nodes represent groupings of the lower-level nodes.}

@item{Repeat for the project's anonymized capital contributions.}

@item{Repeat for the project's anonymized idea contributions.}

@item{Share your analysis with the other attendees.}

]

@subsection[#:style 'unnumbered]{2 Agree on Analysis}

@itemlist[
#:style 'ordered

@item{As a group, discuss to reconcile the different labor analyses to agree on one labor tree that decomposes the project's labor contributions in a way that accounts for all of the independent analyses.}

@item{Repeat step 1 for the capital analysis.}

@item{Repeat step 1 for the ideas analysis.}

]

@subsection[#:style 'unnumbered]{3 Identify Antecedents}

@itemlist[
#:style 'ordered

@item{As a group, annotate each @emph{leaf} idea in the agreed-upon ideas tree with any projects that you can think of, that is, projects exhibiting that idea or a similar idea. These projects need not have any other relationship to the present project besides common ideas, and these should be recorded with no consideration to temporality (i.e. whether the project came before or after the present one). Projects may appear on any number of leaf ideas.}

@item{Identify projects in the annotated ideas tree that were announced within a year (on either side) of the present project, and write those down as a list of identified "cognates," retaining them on the annotated ideas tree. These will be treated in the same way as true antecedents.}

@item{Identify projects in the annotated ideas tree that were announced more than a year after the present project, and write those down as a list of identified "subsequents," removing them from the annotated ideas tree.}

]

@subsection[#:style 'unnumbered]{4 Appraise}

@itemlist[
#:style 'ordered

@item{On your own, starting at the highest node in the labor analysis, appraise the proportion of value contributed by each labor component, progressively working your way into deeper levels of the tree. How important is each component compared to the others? The total of all of the components at each level must equal 100%.}

@item{Repeat (1) for the capital analysis.}

@item{Repeat (1) for the ideas analysis.}

@item{Share your appraisals with the group.}

]

@subsection[#:style 'unnumbered]{5 Agree on Appraisals}

@itemlist[
#:style 'ordered

@item{Discuss to reconcile the different labor appraisals to agree on one appraisal that apportions value in the project in a way that accounts for all of the independent appraisals.}

@item{Repeat (1) for the project's capital appraisal.}

@item{Repeat (1) for the project's ideas appraisal, distributing the value of each "leaf" idea in the tree evenly over its antecedents.}

]

@subsection[#:style 'unnumbered]{6 Reconcile the Appraisals}

Discuss to assign weights to each appraisal tree. Consider using the 1-N-N² rule -- that is, if labor is worth K, then capital is worth 1/N × K, and ideas are worth 1/N² × K, for some "scaling factor" N that you agree on. The rationale is that we want labor, capital and ideas to be equally valuable when aggregated over all projects. Since labor is the least portable while ideas are the most portable, this rule models the fluidity of these categories as, roughly, "for every project you directly work on, N projects will use your work, and N² projects will be inspired by it." Note, nevertheless, that the ideas analysis described elsewhere in this document is not in terms of "inspiration" (implying causation) but only similarity.

@subsection[#:style 'unnumbered]{7 Deanonymize and Tally}

@itemlist[
#:style 'ordered

@item{"Deanonymize" – connect each leaf node in the appraised labor tree to a single contributor in the original non-anonymous list prepared by core project contributors.}

@item{Repeat (1) for capital.}

@item{Sum up the proportions by leaf nodes across all appraisal trees, weighted by the scaling factor for each tree (i.e. in the manner decided upon in "reconcile the appraisals"), to arrive at the final attributive proportions that total to 100%. Deliver this as an abe/ATTRIBUTIONS.txt file in the project repository.}

@item{Deliver the list of cognates and subsequents as abe/cognates.txt and abe/subsequents.txt, respectively, to be committed to the project repository.}

]

@section{Pricing and Valuation}

@itemlist[
#:style 'ordered

@item{Review the cost analysis and proxy analysis provided by the project.}

@item{Come up with a fair market price for use of the project.}

@item{Come up with a valuation of everything created so far in the project.}

]
33 changes: 33 additions & 0 deletions dia-docs/for-project.scrbl
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#lang scribble/manual

@title{For project contributors}

@table-of-contents[]

@section{List contributions}

@itemlist[
#:style 'ordered

@item{Analyze the project and write down all @emph{labor} contributions and who made them. This is just everything you can think of that anyone ever did in the vicinity of the project. Write these down as "X did Y" where X is the name of the person and Y is what they did. The descriptions should be minimally self-contained so as to convey the relevance of the contribution to an informed layperson.}

@item{Share this list with other contributors and community members to solicit input until there is broad agreement that it is comprehensive.}

@item{Commit this list into the project repository at abe/labor.md. Record a unique identifier (such as a commit hash) for the last contribution on the main line of development that is accounted for in the file, i.e. that the list is "current up to." The chosen contribution need not be the most recent one made, but all contributions preceding the chosen one must be accounted for and there should be no gaps of unaccounted contributions.}

@item{Create another file abe/labor-anonymized.md containing the same line items but restated in passive voice without contributor names (e.g. "Y was done" instead of "X did Y").}

@item{Repeat steps 1-4 for all @emph{capital} contributions (e.g. source code, libraries and APIs used) and their sources. The descriptions should be minimally self-contained, as before. Commit this list as abe/capital.md and abe/capital-anonymized.md.}

@item{Repeat steps 1-4 for all @emph{ideas} exhibited by the project. The descriptions should be minimally self-contained, as before. As you will likely think of these ideas in a "top down" fashion, i.e. high level ideas followed by more specific ideas, it would be most helpful to write down this tree representation of these ideas as you see them reflected in your project. Commit this as abe/ideas.md.}
]

@section{Cost analysis and proxy analysis}

@itemlist[
#:style 'ordered

@item{Come up with an estimate of all costs incurred in creating the project. This could include estimates for the cost of labor using suitable hourly wages and number of person hours. Commit this "cost analysis" as abe/cost-analysis.md}

@item{Identify other projects that are similar or analogous to the project and gather information about their pricing and valuation. Commit this "proxy analysis" as abe/proxy-analysis.md}
]

0 comments on commit 87b896b

Please sign in to comment.