Tool Help

Tools on Studiomaven are the representational instruments employed in architectural practice that have a significantly established culture of use. These may be pieces of software, drawing instruments, modeling tools, or mechanical devices. Some tools strongly imply specific methods of engagement (defining both methods internal to the tool and Workflows that expand beyond them), while others remain more flexible in the hands of their users.

Tools contain multiple Parts , each of which belongs to one of three part types: Entity, Interface, or Method. See the Part Help Page for a full discussion of the distinction between these three.

Creating a New Tool

To create a Tool, go to the main Tool page and click on Create a New Tool . Each Tool is named using the following structure: Tool:Toolname_versionnumber . This can be edited later by clicking on Edit with form .

Semantic Structure

Each Tool page has the following semantic properties.

Name

The name of the tool.

Version

The version of the tool, especially if it is software. For example, there is a difference between Rhinoceros for OSX and for Windows, as well as between version 4 and version 5.

Image

The Image is a representative image for this tool. Appears in search results. Typically a screenshot of the splash screen or defining logo. Click on Upload file to add an image.

Manufacturer

The Manufacturer is the company that produced the tool.

Description

Write a short, two to three sentence summary of the tool. Be brief but specific, as this text is searchable but there will be opportunities to elaborate later.

Free-Text Structure

Each Tool page should more-or-less adhere to follow the following structure.

Introduction

Introduce the tool, its function, and its relationship to other tools. Write as if the reader has never used the tool before, but leave specifics to the Part pages.

Overview of Interface

Describe the user interface of the tool--the toolbars, menus, et cetera that the user interacts with. Include a screenshot of a typical window when using the tool.

Other core concepts

As needed, use heading hierarchy for titles to name additional sections. For example, on the tool page for Rhino , there is a section for NURBS to explain its function in Rhino. It is a level 2 heading that is not nested under Overview of Interface. Use title case.

Resources

Links to external resources, files stored on the Studiomaven Dropbox , and any reference material that was used in the creation of the Tool. Structured as a level 2 heading called "Resources". List each resource in a Definition List .