Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Should we add an "assumed knowledge"/"prerequisites" section? #5

Open
kbeyls opened this issue Sep 16, 2021 · 2 comments
Open

Should we add an "assumed knowledge"/"prerequisites" section? #5

kbeyls opened this issue Sep 16, 2021 · 2 comments
Labels
content New content for the book

Comments

@kbeyls
Copy link
Member

kbeyls commented Sep 16, 2021

No description provided.

@kbeyls kbeyls added the content New content for the book label Sep 16, 2021
@sam-ellis
Copy link
Collaborator

How about, we assume the reader is familiar with what a compiler does and its use in software development, but not on their internals. And we assume basic familiarity with computer architecture (CPU, registers, memory) and software concepts such as a arrays, stacks and heaps.

@kbeyls
Copy link
Member Author

kbeyls commented Nov 10, 2021

How about, we assume the reader is familiar with what a compiler does and its use in software development, but not on their internals. And we assume basic familiarity with computer architecture (CPU, registers, memory) and software concepts such as a arrays, stacks and heaps.

Yes, that seems the minimum we should be able to assume.
I guess that in sections that need to go in more detail on code generation, we may have to assume more background knowledge of the general structure of a compiler. Maybe it could help (if readers/reviewers suggest it would be useful) to have a very brief appendix explaining the basics of the structure of a compiler - what is needed to not need to explain basic general compiler internals in the main text)?

I imagine that it will be easiest to highlight what needs to be explained in a glossary or appendix by having reviewers and readers highlight what they do no understand?
Maybe we could write a few words in the introduction encouraging readers to create a github issue if there is content that uses terms/concepts they do not understand?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content New content for the book
Projects
None yet
Development

No branches or pull requests

2 participants