NDLI: Documentation standards for beginning students

Please wait, while we are loading the content...

Some pedagogic considerations in teaching elementary programming using structured FORTRAN

An introductory COBOL course with structured programming

A lesson in recursion and structured programming

Computer science for elementary school teachers

In-service education for teachers of computer science

The IIT MST in computer science program

A course description for teacher education in computer science

Introductory computer science courses a modular design

A ldquo;non-programming” introduction to programming concepts

Introductory programming reconsidered - a user-oriented approach

Documentation standards for beginning students

Does a computer have sexual preferences?

Leading a Child to a Computer Culture

An experimental program in computer usage for secondary students

Teaching teachers about computers: A course description

Planned attitude change while teaching computer literacy

Recommendations on computer science curriculum for undergraduate degree programs

Computer-scored, programmed test monitors student progress

The structure and use of a test generating system designed to facilitate individually paced instruction

Automatic question generation from text - an aid to independent study

Secondary school model automatic test generation

Learning mathematics with recursive computer programs

Teaching a computer-based college level statistics course in a secondary school

Computer graphics as an aid to teaching geometric transformations

The variety of TICCIT systems—an overview

Articulation of computer science curricula at the community colleges and the universities

Realism, style, and design: Packing it into a constrained course

A new approach to teaching a first course in compiler construction

ASSIST-V: A tool for studying the implementation of operating systems

Using GPSS to teach operating systems concepts

On-line large screen display system for computer instruction

Becun the educational computer user's network at battelle

Instructional uses of the olin experimental classroom

Computer-controlled display demonstrations of dynamic concepts in computer science

Speech synthesis for computer assisted instruction: The MISS system and its applications

On the uses of models in education

Modeling the student and the discipline in CAI drill and practice

A tutoring and student modelling paradigm for gaming environments

Another look at the discrete structures course

How much cai is hidden in commercial software?

A proposed course on data processing economics

Software engineering education: Needs and objectives

Report on acm's activity on community and junior college curriculum career program in computer programming

The bayesian computer-assisted data analysis (CADA) monitor

QUICK: A quasi-interactive computer-based instructional system

A generalized system for university mathematics instruction

The use of information theory and personal probabilities in computer based learning

Learning theory and political socialization: A module for computer assisted instruction

Multi-disciplinary programming exercises

Computing science courses - training or education?

What is a first-year computer science graduate student?

An evaluation of the data processing program at eastern kentucky univ.

A survey on computer science curricula

Computers and society courses and computer literacy (panel session)

An instructional interpreter for basic

An interactive program advising system

An interactive pseudo-assembler for introductory computer science

A computer-aided flow diagram teaching system

A unique graduate program in computer science at Jackson State University

The master of science program in computer and information science at San Jose State University

A diversified undergraduate computer science program

Panel discussion: Intelligent instructional systems

The stepwise approach to introductory programming projects with examples

Computer science and minority colleges & universities: The Jackson State University NSF educational computing network

A video disc oriented educational system

A functional model of instructional programs

Documentation standards for beginning students

Content Provider	ACM Digital Library
Author	Brewer, Richard K.
Abstract	The importance of writing programs that are readable has finally gained preeminence in the struggle with such competing and contradictory goals as “cuteness” and “optimization” of code. As a result, a much greater stress on documentation standards is found in computer science education these days. Industry and government standards for documentation are being more widely adhered to and certain points of agreement have emerged. Some excellent books have been written that cover the subject (Van Tassel, 1974; Ledgard, 1975; Kernighan & Plauger, 1974); however it is safe to say that both the exhaustive treatment of the subject in such publications and the extremely high standards proposed probably preclude wholesale adoption by instructors of beginning level programming courses. What is proposed here is a set of common sense, scaled down documentation standards for the student in a first programming course in, say, FORTRAN, PL/I, ALGOL, or Basic. The following represents an amalgam of documentation requirements achieved as a result of teaching introductory programming to college students for nine years. The actual sources have been the literature, colleagues, and last but not least, experience. They are not intended to represent an “only” or “best” approach; the author has recently encountered other efforts in this direction that must surely be as reasonable and effective. It does represent one educator's approach; it is sufficiently scaled down so that one might reasonably expect to use it as a standard for beginning students; and it may be most useful as a contributor of components to be integrated into a more effective set of standards. The basics of documentation and readable programming include comments, meaningful variable names, labelled output, flowcharts, and clear program flow. The major components of and basic rules for each of these categories will be presented in the context of the needs and limitations of the beginning student.
Starting Page	69
Ending Page	73
Page Count	5
File Format	PDF
DOI	10.1145/800107.803450
Language	English
Publisher	Association for Computing Machinery (ACM)
Publisher Date	1976-02-01
Publisher Place	New York
Access Restriction	Subscribed
Content Type	Text
Resource Type	Article

Central Library (ISO-9001:2015 Certified)
Indian Institute of Technology Kharagpur
Kharagpur, West Bengal, India | PIN - 721302

See location in the Map
03222 282435
Mail: support@ndl.gov.in

Sl.	Authority	Responsibilities	Communication Details
1	Ministry of Education (GoI), Department of Higher Education	Sanctioning Authority	https://www.education.gov.in/ict-initiatives
2	Indian Institute of Technology Kharagpur	Host Institute of the Project: The host institute of the project is responsible for providing infrastructure support and hosting the project	https://www.iitkgp.ac.in
3	National Digital Library of India Office, Indian Institute of Technology Kharagpur	The administrative and infrastructural headquarters of the project	Dr. B. Sutradhar bsutra@ndl.gov.in
4	Project PI / Joint PI	Principal Investigator and Joint Principal Investigators of the project	Dr. B. Sutradhar bsutra@ndl.gov.in Prof. Saswat Chakrabarti will be added soon
5	Website/Portal (Helpdesk)	Queries regarding NDLI and its services	support@ndl.gov.in
6	Contents and Copyright Issues	Queries related to content curation and copyright issues	content@ndl.gov.in
7	National Digital Library of India Club (NDLI Club)	Queries related to NDLI Club formation, support, user awareness program, seminar/symposium, collaboration, social media, promotion, and outreach	clubsupport@ndl.gov.in
8	Digital Preservation Centre (DPC)	Assistance with digitizing and archiving copyright-free printed books	dpc@ndl.gov.in
9	IDR Setup or Support	Queries related to establishment and support of Institutional Digital Repository (IDR) and IDR workshops	idr@ndl.gov.in