Anda di halaman 1dari 14

SciTechStyleGuide

ForSciTechStyleGuildVersion1.0

Scope&Purpose
Appliesto:
Labreports
FinalDesignReport(FDR)
FailureReport(FR)
SuccessReport(SR)
AnyotherdigitallycreateddocumentsforSciTech

Authorship
Documentationshoulddetailallofyoureffortsandrepresentyour
originalworkandengineeringpractice.
"OnmyhonorIhaveneithergivennorreceivedanyunauthorizedaid
onmywork,nordoItolerateacademicdishonestyinothers." LASA
StudentHonorCode
Duetotheuniquenessofeachteamseffortsanyplagiarismonyour
partwouldmostlikelynotresultinahighergradethanevenacursory
effortmadefororiginalwork.

FileTypes
DocumentType

FinalFormat

EditableFormat

TextDocument

Word(.docx)

Word(.docx)

LabReport

Word(.docx)

Word(.docx)

SolidWorksParts

JPEG

SolidWorksPartFile
(.sldprt)

SolidWorksAssembly

JPEG

SolidWorksAssemblyFile
(.sldasm)

EngineeringDrawings

PDForJPEG(assignment
dependent)

Drawingfile(.slddrw)

FileNomenclature&Submission
Alldocumentsthataredigitallysubmittedtoateachermust
followthenamingconventionbelow.Theexampleisforastudent
namedJacksonPaceingroup5ofclass15
Submitter Format

Example

Individual Class.Last.First.Assignment 15.Pace.Jackson.Lab1


Group

15.GroupX.Assignment

15.Group5.FDR

Submissionmethodswillbedetailedbyyourteacherwhennecessary.
Hardcopysubmissiongreaterthan1pagemusthavebindingmethod.

PageLayout
1Margins
0.5indentations
Bodytextis12TimesNewRomaninautomaticblack
Bold,Italic,andunderlinehavedetailedusage

Headers,Footers,Titles,&Sections
Header:
Nameorgroupnumberleftaligned
Titleofdocumentrightaligned

Footer
Pagenumbercenteraligned.Noromannumerals

Titles:
Solidcolor,TimesNewRoman,size16,Bold
Subsectionsaresize13,notbold
Leftaligned

Text&Audience
DocumentsshouldbewritteninStandardAmericanProsewithproper
punctuationandgrammar.
Consideryouraudience.
Whoisreadingthisdocument?
Howknowledgeablearetheyofthetopic?
Whatwouldbetoomuch/littleinformationtogetapointacross?

Voice
Professionaldocumentsshouldbewritteninaremovedthirdperson
perspective.InsteadofI,our,orweusethey,their,aname,or
theteam.
Singular
FirstPerson Usingourorthographic
drawingsIusedthedrillpress
anda3/8inchbittofabricate
thedevicesbase.
Third
Person

Usingtheteamsorthographic
drawingsJacksonusedthedrill
pressanda3/8inchbitto
fabricatethedevicesbase.

Plural
Oncethedevicewasfully
constructedwebegantesting
ourdevicetoquantifyits
efficiency.
Oncethedevicewasfully
constructedtheteambegan
testingrepeatedtoquantify
itsefficiency.

Spreadsheets
Allvaluesroundedtonearesttenth(orpenny)
OnlyrawdataismanuallyinputintoExcel.Calculateddataisfound
usingExcelfunctions
Cellsshouldbeeasilyreadableandtextwrapped
Rawdatasetsshouldbecoloreddifferentlytovisuallyseparateit
fromcalculateddata
InsertedintoWordasanObjectforfutureinspection&editing

BillofMaterials(BOM)
Bill of Materials
Part

Material

Cost of
Material

Per Units

Amount Used

Units

# of Parts

Total Cost of
Material

A-Base 1

1/2" Louanne Plywood

$0.75

ft^2

16.00

in^2

1.00

$0.08

B-Base 2

1/2" Louanne Plywood

$0.75

ft^2

9.00

in^2

1.00

$0.05

C-Base 3

1/2" Louanne Plywood

$0.75

ft^2

4.00

in^2

1.00

$0.02

D-Stand

1/2" Louanne Plywood

$0.75

ft^2

7.00

in^2

1.00

$0.04

E-Arm

3/32" Wire

$0.09

foot

12.00

in

1.00

$0.09

F-Mousetrap

Mousetrap

$0.39

mousetrap

1.00

each

1.00

$0.39

G-Scoop Base

1/2" Louanne Plywood

$0.75

ft^2

0.31

in^2

1.00

$0.00

H-Scoop Track

3/32" Wire

$0.09

foot

10.00

in

1.00

$0.08

I-Nails
J-Hot Glue

Nails
Hot Glue Stick

$0.78
$0.05

lb
each

10.00
1.00

nails
each

1.00
3.00

$0.05
$0.15

K-Trigger

1/2" Louanne Plywood

$0.75

ft^2

0.03

in^2

1.00

$0.00

Unit

grams

lb.

Grand Total

$0.94

grams

26.20

0.06

Nails Quantity
10.00

2.62

InTextReferences
Citinganoutsidesource:
Theconstructioncalledfor1fishingweight.Apackageof18
was$3.19resultinginafairmarketvalueof$0.18[4].
CitingaLogBook:
Whentheprototypefailedtheteamobservedthattheright
wheelsaxlewasnotcircularcausinganextremewobble(Pace,
41216).
ReferencinganAppendix:
Thespindleofthedevicehasaholedrilledata45 angle
neartheend[A.5].

Appendices
Thereare4requiredappendicesfortheFDR.Thelabelingschemewill
betheletter.number oftheitem.
ThefourthiteminAppendixAis[A.4]
ThefirstiteminAppendixDis[D.1]
ThefifthiteminAppendixBis[B.5]

Disclaimer
Thispresentationisonlyanoverviewofhowyourdocumentsshould
beformatted.Athoroughreadingofthestyleguideaswellasregular
referencingduringthecompositionofdocumentsisneededtoensure
compliance.
Additionally,theguideisultimatelyincomplete,uptoteacher
discretion,andopentostudentinterpretationwhennotgivenenough
detail.Studentswillbegivennoticewhenupdatestothestyleguide
aremadeandwhatthoseupdatesentail.

Anda mungkin juga menyukai