Skip to content
This repository has been archived by the owner on Jan 26, 2022. It is now read-only.

Readme: Separate additional features, goals, nomenclature, term rewriting, and relations to other proposals and languages #25

Closed
js-choi opened this issue Mar 24, 2018 · 1 comment
Assignees
Labels
explainer/readme About readme.md

Comments

@js-choi
Copy link
Collaborator

js-choi commented Mar 24, 2018

From IRC #tc39 today with @littledan:

littledan (Daniel Ehrenberg): …I think this could partly be addressed by a simpler-looking document layout (e.g., maybe split off the explainer pieces about follow-on proposals into separate md documents?) …

jschoi (J. S. Choi): Regarding the explainer: I can try separating the additional features into their own explainer documents. This is probably long overdue, but I have been focusing on the specification for the past week. I’ll make an issue for this in the smart-pipelines repository.

jschoi (J. S. Choi): The specification is currently a single document too, with an annex for each additional feature. Is this similarly too confusing or overwhelming for the reader? Should I consider separating the specification also? Perhaps I should.

littledan (Daniel Ehrenberg): I think the specification being in one document vs multiple documents is less important, as many fewer people read and understand the specification compared to the explainer. The specification is usually unintelligible to most audiences, and difficult to the rest of them, no matter how you cut it.

jschoi (J. S. Choi): Noted; thank you.

littledan (Daniel Ehrenberg): oh, another contradiction: explaining everything fully vs concisely emphasizing the important stuff

jschoi (J. S. Choi): The real-world examples hopefully help concretize how it would look, but…yes.

10:35 AM littledan (Daniel Ehrenberg): the readme is very long! this means you have spoken to many things, but a portion of the audience will just be unaware of your thought process. This is an inherent difficulty

10:36 AM jschoi (J. S. Choi): That’s true too. Maybe I should make an explainer explainer, pfft. Or separate the examples…? I think the examples do help make it seem more compelling.

Yes. Hopefully the readme split will help.

At least on a communicative level, though not so much at a fundamental-tradeoff level.

@js-choi js-choi self-assigned this Mar 24, 2018
@js-choi js-choi added this to In progress in Complete first explainers Mar 24, 2018
@js-choi js-choi added the explainer/readme About readme.md label Mar 24, 2018
@js-choi js-choi changed the title Readme: Separate additional features Readme: Separate additional features, goals, nomenclature, term rewriting, and relations to other proposals and languages Mar 25, 2018
js-choi added a commit that referenced this issue Mar 26, 2018
js-choi added a commit that referenced this issue Mar 26, 2018
js-choi added a commit that referenced this issue Mar 26, 2018
@js-choi
Copy link
Collaborator Author

js-choi commented Dec 8, 2018

The split is done for now; see 8a41876. Hopefully this addresses @littledan’s suggestions; the advice is still very much appreciated.

@js-choi js-choi closed this as completed Dec 8, 2018
Complete first explainers automation moved this from In progress to Done Dec 8, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
explainer/readme About readme.md
Projects
Development

No branches or pull requests

1 participant