Course Hero Logo

Proficient use of some of the tools discussed

Course Hero uses AI to attempt to automatically extract content from documents to surface to you and others so you can study better, e.g., in search results, to enrich docs, and more. This preview shows page 44 - 45 out of 87 pages.

Proficient use of some of the tools discussed previously can eliminate the need to pulldivergent results and ideas together at the end of a project with additional documentation.However, at the very minimum it is good software project etiquette to document theprocedure describing how to set up and run the application, helping future developers toget up and running quickly.The need for extensive end-user documentation is largely disappearing as softwarebecomes increasingly intuitive, with emphasis on User Experience and User InterfacedesignInstallation instructionsOnce people figure out whether they want to use your code or not, they need to know howto get it and make it run. Hopefully your install instructions should be a couple lines for thebasic case. A page that gives more information and caveats should be linked from here ifnecessary.ReadmeYour first steps in documentation should go into your README. Code hosting services willrender your README into HTML automatically if you provide the proper extension. It is alsothe first interaction that most users will have with your project. So, having a solid READMEwill serve your project well.Use Organisation document conventionA file naming convention is a systematic method for naming files. Your file namingconvention will always be your most powerful and easy method for organising andretrieving your documents. You want to get this right the first time, so it is important toinvest enough time to think about this carefully.A consistent and descriptive file naming convention serves many purposes, often related tobranding, information management, and usability. The overall goal of intentional filenaming is to increase readability in file names. It empowers people new to the content tonavigate files more easily, makes searching and finding documents easier by having ourfilenames reflect file contents, and guides file authors to develop each document around asingle, concrete purpose, which reduces clutter. More concretely, it allows you to:Know the content of a document without opening it.Retrieve and filter documents very quickly using the search/filter function of yourcomputer.Store documents in a single folder without losing their context, if you need to.Find and identify documents even if they are no longer in their original folder.Easily browse long lists of files to inventory or check for missing documents.Manage documents more easily on your website (often content managementsystems store documents in a single “upload” directory).Designing your file naming convention1.Starting your filename with the most important parameter/componentwillallow you to organise documents alphabetically (or chronologically) with thatparameter without having to do any searching. For example, if your primary methodof accessing a litigation case file is its number, then this should be the first elementPage | 43

Upload your study docs or become a

Course Hero member to access this document

Upload your study docs or become a

Course Hero member to access this document

End of preview. Want to read all 87 pages?

Upload your study docs or become a

Course Hero member to access this document

Term
Spring
Professor
N/A
Tags
Object Oriented Programming, Requirements analysis, developer

Newly uploaded documents

Show More

Newly uploaded documents

Show More

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture