In this class you will rewrite your ECE 4760 final project report to meet the style of a magazine or journal of your choice, then submit it for publication. The course does not require that the manuscript be published, only that you get it to the point of submission. About half a dozen ECE4760 projects have made it into print each of the last two years and about sixty have be published since 2002. Publishing your work is a good way to advertise your abilities and to protect yourself against plagiarism of your project. However publishing your work may limit intellectual property protection possibilities.
This course fulfills the College of Engineering Technical Communication requirement.
It may also be used as a advisor-approved elective.
Procedure
The goal will be to rewrite (and perhaps extend) your final project report in ECE4760 for publication. You must have taken ECE4760 the previous Fall. To do this you will need to:
- Print out the form required to add the course!
Form must be submitted first or second week of classes.
Typically completed at first meeting with instructor. - Pick a publication to target. Depending on the project, the target could be a computing or music magazine, or a IEEE journal or IEEE conference. I will help you choose a target publication with a reasonable chance of publication. [Only a few projects will support submission to an IEEE publication.]
- Obtain the style guide for the target publication and read it (see below for some links).
- Read some articles from the target publication.
- IF your project was a group project then you must consider the IP of your partners
and do one of:- All partners participate in this class and therefore be co-authors.
- Some partners do not participate in this class and must each specify TO ME in email one of two options:
- They will be co-authors and therefore participate in approving the writing,
but not do the writing. - They will not be co-authors and therefore will acknoledged, but not participate.
- They will be co-authors and therefore participate in approving the writing,
- Rewrite your final project report:
- Reorganize for top-down explanation of the project.
Take a step back and consider the non-specialist reader. Have a friend who is not an engineer read it. - Remove all local references (e.g. "We used Bruce's board.") and replace with more general statements.
- Delete the ABET-specific sections and convert it to a design narrative suitable for the target audience.
In most cases, ethics, safety, and work distribution will not be part of the final manustript. - Find, analyse, and incorporate appropriate background publications
Build a reference list to include in the manuscript. - Reorganize, re-analyse and extend the results section of the original report, which is often written in a hasty fashion at the end of 4760.
- Do not include any code in the text of the manuscript. Convert it to words.
Occasional execption can be made for very tricky code, but never for PLIB statments. - Follow the style guide for the target publication
- Repeat from step 1
- Reorganize for top-down explanation of the project.
- At about the third revision, make sure you are following the style guide for the target publication.
- Revise often.
- Submit the manuscript to the magazine/journal!
Time Line
- Meet to talk about strategy the first or second week of classes.
-- meeting will last 20-40 minutes
-- Bring this form with you
--Discuss the style guide(s) you have already read.
--Discuss the article(s) you have already read. - First draft due by week 4 of classes, (week of 10feb2020)
-- meet to mark up hardcopy draft.
-- The first draft must be reformated into about 4 sections, have removed localisms, and removed redundancy resulting from the section structure (and quick writing) of the lab report.
-- all images, except perhaps a full schematic, should be included - Second draft due by week 7 of classes, (week of 2mar2020)
-- meet to mark up hardcopy draft.
-- edit toward magazine guidlines, check figures, figure captions, full schematic - Third draft due by week 10 of classes. (week of 23mar2020)
-- As you can see, the number of drafts is usually 3 or 4. (median=3, mean=3.5)
-- meet to mark up and check for following the style guide for the target publication - Fourth draft (if necessary) week 13 of classes (week of 13april2020)
-- meet to mark up and check for following the style guide for the target publication - Fifth draft (if necessary) week of 4may2020
-- meet to mark up and check for following the style guide for the target publication - Submit the manuscript to the magazine/journal, and copy the instructor!
There may be occasional circumstances in which the manuscript will not be
submitted, for instance, if there are IP issues.
Grading
Grades will be based on:
- --Timely submission of writing drafts during the semester.
Your grade will fall if you miss a deadline! A late draft will lose one grade-step per week.
(A grade-step means, for instance A to A-, or B+ to B)
-- A first draft which is a cut/paste hack of the course final report will lose two grade-steps!
--Most manuscipts require three or four drafts, but a few may require five. - --Attention to detail (top-down explanation, grammar, sentence structure, paragraph structure).
- --Increase in draft quality with each draft.
Failure of improvment in a draft may result in lose of one or more grade-steps. - --Quality of the final draft. If we get to the end of semester and your writing is not acceptable
you will lose one or more grade-steps.
-- Failure to finish by draft #5 will result in a significant grade reduction
(at least one whole letter grade).
-- Failure to submit a finished manuscript to the magazine/journal
by the end of finals will result in a significant grade reduction.
(at least one whole letter grade). There may be occasional circumstances
in which the manuscript submission will be waived, for instance, if there are IP issues.
Your grade is not dependent on the manuscript being accepted for publication.
References
Style Guides
- IEEE style guide
- IEEE Access -- Multidisciplinary Open Access Journal
- IEEE Computer Society style guide
- ACM
- Circuit Cellar Magazine -- Style guide and submission instructions
- Nuts and Volts Magazine -- writer's guidelines
- Hackspace Magazine -- brief guidelines
- Elektor Magazine -- Policy -- Contact
- Electronics World Magazine -- contact
Example manuscripts and publication venues
- Circuit Cellar (by Syed Tahmid Mahbub and Bruce Land, DMA example)
- IEEE conference (by Hana Qudsi, Maneesh Gupta, ece4760 project)
- Journal of Neuroscience methods ( by two ECE undergrads, Kyle D. Wesson, Robert M. Ochshorn from ece4760 project)
- Biosensors and Bioelectronics ( by BEE grad student Elliot Friedman from an ece4760 project)
- Proc. of ASME Conf. on Smart Materials, Adaptive Structures and Intelligent Systems (by MAE grad students Schlichting, A., Shafer, M., ece4760 project)
- Proceedings of the 8th International Conference on New Interfaces for Musical Expression (by Andrew Godbehere and Nathan Ward, ece4760 project)
List of published projects from ece4760 and ece5760 since 2002